30502 lines
3.4 MiB
30502 lines
3.4 MiB
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>SharpDX.MediaFoundation</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:SharpDX.MediaFoundation.AssemblyDoc">
|
|
<summary>
|
|
The <see cref="A:SharpDX.MediaFoundation"/> assembly provides managed MediaFoundation API.
|
|
</summary>
|
|
<msdn-id></msdn-id>
|
|
<unmanaged>MediaFoundation</unmanaged>
|
|
<unmanaged-short>MediaFoundation</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ActivateCustomMixerFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='__MIDL___MIDL_itf_mfidl_0000_0023_0001']/*"/>
|
|
<unmanaged>__MIDL___MIDL_itf_mfidl_0000_0023_0001</unmanaged>
|
|
<unmanaged-short>__MIDL___MIDL_itf_mfidl_0000_0023_0001</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ActivateCustomMixerFlags.AllowFail">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ACTIVATE_CUSTOM_MIXER_ALLOWFAIL']/*"/>
|
|
<unmanaged>MF_ACTIVATE_CUSTOM_MIXER_ALLOWFAIL</unmanaged>
|
|
<unmanaged-short>MF_ACTIVATE_CUSTOM_MIXER_ALLOWFAIL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ActivateCustomMixerFlags.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.MediaFoundation.ActivateCustomPresenterFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='__MIDL___MIDL_itf_mfidl_0000_0023_0002']/*"/>
|
|
<unmanaged>__MIDL___MIDL_itf_mfidl_0000_0023_0002</unmanaged>
|
|
<unmanaged-short>__MIDL___MIDL_itf_mfidl_0000_0023_0002</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ActivateCustomPresenterFlags.AllowFail">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ACTIVATE_CUSTOM_PRESENTER_ALLOWFAIL']/*"/>
|
|
<unmanaged>MF_ACTIVATE_CUSTOM_PRESENTER_ALLOWFAIL</unmanaged>
|
|
<unmanaged-short>MF_ACTIVATE_CUSTOM_PRESENTER_ALLOWFAIL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ActivateCustomPresenterFlags.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.MediaFoundation.AsfIndexerflags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines the ASF indexer options.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_INDEXERFLAGS']/*"/>
|
|
<msdn-id>ms704695</msdn-id>
|
|
<unmanaged>MFASF_INDEXERFLAGS</unmanaged>
|
|
<unmanaged-short>MFASF_INDEXERFLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfIndexerflags.WriteNewIndex">
|
|
<summary>
|
|
<dd> <p>The indexer creates a new index object.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_INDEXER_WRITE_NEW_INDEX']/*"/>
|
|
<msdn-id>ms704695</msdn-id>
|
|
<unmanaged>MFASF_INDEXER_WRITE_NEW_INDEX</unmanaged>
|
|
<unmanaged-short>MFASF_INDEXER_WRITE_NEW_INDEX</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfIndexerflags.ReadForReverseplayback">
|
|
<summary>
|
|
<dd> <p>The indexer returns values for reverse playback.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_INDEXER_READ_FOR_REVERSEPLAYBACK']/*"/>
|
|
<msdn-id>ms704695</msdn-id>
|
|
<unmanaged>MFASF_INDEXER_READ_FOR_REVERSEPLAYBACK</unmanaged>
|
|
<unmanaged-short>MFASF_INDEXER_READ_FOR_REVERSEPLAYBACK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfIndexerflags.WriteForLiveread">
|
|
<summary>
|
|
<dd> <p>The indexer creates an index object for a live ASF stream.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_INDEXER_WRITE_FOR_LIVEREAD']/*"/>
|
|
<msdn-id>ms704695</msdn-id>
|
|
<unmanaged>MFASF_INDEXER_WRITE_FOR_LIVEREAD</unmanaged>
|
|
<unmanaged-short>MFASF_INDEXER_WRITE_FOR_LIVEREAD</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfIndexerflags.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.MediaFoundation.AsfMultiplexerflags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_MULTIPLEXERFLAGS']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFASF_MULTIPLEXERFLAGS</unmanaged>
|
|
<unmanaged-short>MFASF_MULTIPLEXERFLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfMultiplexerflags.AutoadjustBitrate">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_MULTIPLEXER_AUTOADJUST_BITRATE']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFASF_MULTIPLEXER_AUTOADJUST_BITRATE</unmanaged>
|
|
<unmanaged-short>MFASF_MULTIPLEXER_AUTOADJUST_BITRATE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfMultiplexerflags.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.MediaFoundation.AsfSelectionStatus">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Describes the current status of a call to the <strong><see cref="M:SharpDX.MediaFoundation.Shutdownable.Shutdown"/></strong> method.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_SELECTION_STATUS']/*"/>
|
|
<msdn-id>ms701630</msdn-id>
|
|
<unmanaged>ASF_SELECTION_STATUS</unmanaged>
|
|
<unmanaged-short>ASF_SELECTION_STATUS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfSelectionStatus.TatusNotselected">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_STATUS_NOTSELECTED']/*"/>
|
|
<unmanaged>ASF_STATUS_NOTSELECTED</unmanaged>
|
|
<unmanaged-short>ASF_STATUS_NOTSELECTED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfSelectionStatus.TatusCleanpointsonly">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_STATUS_CLEANPOINTSONLY']/*"/>
|
|
<unmanaged>ASF_STATUS_CLEANPOINTSONLY</unmanaged>
|
|
<unmanaged-short>ASF_STATUS_CLEANPOINTSONLY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfSelectionStatus.TatusAlldataunits">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_STATUS_ALLDATAUNITS']/*"/>
|
|
<unmanaged>ASF_STATUS_ALLDATAUNITS</unmanaged>
|
|
<unmanaged-short>ASF_STATUS_ALLDATAUNITS</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsfSplitterflags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_SPLITTERFLAGS']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFASF_SPLITTERFLAGS</unmanaged>
|
|
<unmanaged-short>MFASF_SPLITTERFLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfSplitterflags.Reverse">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_SPLITTER_REVERSE']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFASF_SPLITTER_REVERSE</unmanaged>
|
|
<unmanaged-short>MFASF_SPLITTER_REVERSE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfSplitterflags.Wmdrm">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_SPLITTER_WMDRM']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFASF_SPLITTER_WMDRM</unmanaged>
|
|
<unmanaged-short>MFASF_SPLITTER_WMDRM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfSplitterflags.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.MediaFoundation.AsfStatusflags">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Specifies a type of capture device.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_STATUSFLAGS']/*"/>
|
|
<msdn-id>hh162811</msdn-id>
|
|
<unmanaged>ASF_STATUSFLAGS</unmanaged>
|
|
<unmanaged-short>ASF_STATUSFLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfStatusflags.Incomplete">
|
|
<summary>
|
|
<dd> <p>An audio capture device, such as a microphone.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_STATUSFLAGS_INCOMPLETE']/*"/>
|
|
<msdn-id>hh162811</msdn-id>
|
|
<unmanaged>ASF_STATUSFLAGS_INCOMPLETE</unmanaged>
|
|
<unmanaged-short>ASF_STATUSFLAGS_INCOMPLETE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfStatusflags.NonfatalError">
|
|
<summary>
|
|
<dd> <p>A video capture device, such as a webcam.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_STATUSFLAGS_NONFATAL_ERROR']/*"/>
|
|
<msdn-id>hh162811</msdn-id>
|
|
<unmanaged>ASF_STATUSFLAGS_NONFATAL_ERROR</unmanaged>
|
|
<unmanaged-short>ASF_STATUSFLAGS_NONFATAL_ERROR</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfStatusflags.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.MediaFoundation.AsfStreamselectorflags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines the ASF stream selector options.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_STREAMSELECTORFLAGS']/*"/>
|
|
<msdn-id>ms696200</msdn-id>
|
|
<unmanaged>MFASF_STREAMSELECTORFLAGS</unmanaged>
|
|
<unmanaged-short>MFASF_STREAMSELECTORFLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfStreamselectorflags.DisableThinning">
|
|
<summary>
|
|
<dd> <p>The stream selector will not set thinning. Thinning is the process of removing samples from a stream to reduce the bit rate.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_STREAMSELECTOR_DISABLE_THINNING']/*"/>
|
|
<msdn-id>ms696200</msdn-id>
|
|
<unmanaged>MFASF_STREAMSELECTOR_DISABLE_THINNING</unmanaged>
|
|
<unmanaged-short>MFASF_STREAMSELECTOR_DISABLE_THINNING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfStreamselectorflags.UseAverageBitrate">
|
|
<summary>
|
|
<dd> <p>The stream selector will use the average bit rate of streams when selecting streams.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASF_STREAMSELECTOR_USE_AVERAGE_BITRATE']/*"/>
|
|
<msdn-id>ms696200</msdn-id>
|
|
<unmanaged>MFASF_STREAMSELECTOR_USE_AVERAGE_BITRATE</unmanaged>
|
|
<unmanaged-short>MFASF_STREAMSELECTOR_USE_AVERAGE_BITRATE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfStreamselectorflags.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.MediaFoundation.AsyncWorkqueueType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates a new work queue. This function extends the capabilities of the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> function by making it possible to create a work queue that has a message loop.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>When you are done using the work queue, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockWorkQueue(System.Int32)"/></strong>.</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> function is equivalent to calling <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueueEx(SharpDX.MediaFoundation.AsyncWorkqueueType,System.Int32@)"/></strong> with the value <see cref="F:SharpDX.MediaFoundation.AsyncWorkqueueType.MfStandardWorkqueue"/> for the <em>WorkQueueType</em> parameter.</p><p>This function is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASYNC_WORKQUEUE_TYPE']/*"/>
|
|
<msdn-id>dd375150</msdn-id>
|
|
<unmanaged>MFASYNC_WORKQUEUE_TYPE</unmanaged>
|
|
<unmanaged-short>MFASYNC_WORKQUEUE_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsyncWorkqueueType.MfStandardWorkqueue">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_STANDARD_WORKQUEUE']/*"/>
|
|
<unmanaged>MF_STANDARD_WORKQUEUE</unmanaged>
|
|
<unmanaged-short>MF_STANDARD_WORKQUEUE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsyncWorkqueueType.MfWindowWorkqueue">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_WINDOW_WORKQUEUE']/*"/>
|
|
<unmanaged>MF_WINDOW_WORKQUEUE</unmanaged>
|
|
<unmanaged-short>MF_WINDOW_WORKQUEUE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsyncWorkqueueType.MfMultithreadedWorkqueue">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_MULTITHREADED_WORKQUEUE']/*"/>
|
|
<unmanaged>MF_MULTITHREADED_WORKQUEUE</unmanaged>
|
|
<unmanaged-short>MF_MULTITHREADED_WORKQUEUE</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AttributeSerializeOptions">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines flags for serializing and deserializing attribute stores.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTE_SERIALIZE_OPTIONS']/*"/>
|
|
<msdn-id>ms704675</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTE_SERIALIZE_OPTIONS</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_SERIALIZE_OPTIONS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributeSerializeOptions.UnknownByref">
|
|
<summary>
|
|
<dd> <p>If this flag is set, <strong><see cref="T:SharpDX.ComObject"/></strong> references in the attribute store are marshaled to and from the stream. If this flag is absent, <strong><see cref="T:SharpDX.ComObject"/></strong> references in the attribute store are not marshaled or serialized.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTE_SERIALIZE_UNKNOWN_BYREF']/*"/>
|
|
<msdn-id>ms704675</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTE_SERIALIZE_UNKNOWN_BYREF</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_SERIALIZE_UNKNOWN_BYREF</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AttributesMatchType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Specifies how to compare the attributes on two objects.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTES_MATCH_TYPE']/*"/>
|
|
<msdn-id>ms703793</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTES_MATCH_TYPE</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTES_MATCH_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributesMatchType.OurItems">
|
|
<summary>
|
|
<dd> <p>Check whether all the attributes in <em>pThis</em> exist in <em>pTheirs</em> and have the same data, where <em>pThis</em> is the object whose <strong>Compare</strong> method is being called and <em>pTheirs</em> is the object given in the <em>pTheirs</em> parameter.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTES_MATCH_OUR_ITEMS']/*"/>
|
|
<msdn-id>ms703793</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTES_MATCH_OUR_ITEMS</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTES_MATCH_OUR_ITEMS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributesMatchType.TheirItems">
|
|
<summary>
|
|
<dd> <p>Check whether all the attributes in <em>pTheirs</em> exist in <em>pThis</em> and have the same data, where <em>pThis</em> is the object whose <strong>Compare</strong> method is being called and <em>pTheirs</em> is the object given in the <em>pTheirs</em> parameter.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTES_MATCH_THEIR_ITEMS']/*"/>
|
|
<msdn-id>ms703793</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTES_MATCH_THEIR_ITEMS</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTES_MATCH_THEIR_ITEMS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributesMatchType.AllItems">
|
|
<summary>
|
|
<dd> <p>Check whether both objects have identical attributes with the same data.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTES_MATCH_ALL_ITEMS']/*"/>
|
|
<msdn-id>ms703793</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTES_MATCH_ALL_ITEMS</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTES_MATCH_ALL_ITEMS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributesMatchType.Intersection">
|
|
<summary>
|
|
<dd> <p>Check whether the attributes that exist in both objects have the same data.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTES_MATCH_INTERSECTION']/*"/>
|
|
<msdn-id>ms703793</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTES_MATCH_INTERSECTION</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTES_MATCH_INTERSECTION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributesMatchType.Smaller">
|
|
<summary>
|
|
<dd> <p>Find the object with the fewest number of attributes, and check if those attributes exist in the other object and have the same data.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTES_MATCH_SMALLER']/*"/>
|
|
<msdn-id>ms703793</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTES_MATCH_SMALLER</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTES_MATCH_SMALLER</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AttributeType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Defines the data type for a key/value pair.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTE_TYPE']/*"/>
|
|
<msdn-id>ms694854</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTE_TYPE</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributeType.UInt32">
|
|
<summary>
|
|
<dd> <p>Unsigned 32-bit integer.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTE_UINT32']/*"/>
|
|
<msdn-id>ms694854</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTE_UINT32</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_UINT32</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributeType.UInt64">
|
|
<summary>
|
|
<dd> <p>Unsigned 64-bit integer.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTE_UINT64']/*"/>
|
|
<msdn-id>ms694854</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTE_UINT64</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_UINT64</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributeType.Double">
|
|
<summary>
|
|
<dd> <p>Floating-point number.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTE_DOUBLE']/*"/>
|
|
<msdn-id>ms694854</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTE_DOUBLE</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_DOUBLE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributeType.Guid">
|
|
<summary>
|
|
<dd> <p><strong><see cref="T:System.Guid"/></strong> value.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTE_GUID']/*"/>
|
|
<msdn-id>ms694854</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTE_GUID</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_GUID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributeType.String">
|
|
<summary>
|
|
<dd> <p><c>null</c>-terminated wide-character string.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTE_STRING']/*"/>
|
|
<msdn-id>ms694854</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTE_STRING</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_STRING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributeType.Blob">
|
|
<summary>
|
|
<dd> <p>Byte array.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTE_BLOB']/*"/>
|
|
<msdn-id>ms694854</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTE_BLOB</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_BLOB</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AttributeType.IUnknown">
|
|
<summary>
|
|
<dd> <p><strong><see cref="T:SharpDX.ComObject"/></strong> reference.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ATTRIBUTE_IUNKNOWN']/*"/>
|
|
<msdn-id>ms694854</msdn-id>
|
|
<unmanaged>MF_ATTRIBUTE_IUNKNOWN</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_IUNKNOWN</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AudioConstriction">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAudioConstriction']/*"/>
|
|
<unmanaged>MFAudioConstriction</unmanaged>
|
|
<unmanaged-short>MFAudioConstriction</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AudioConstriction.MFaudioConstrictionOff">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFaudioConstrictionOff']/*"/>
|
|
<unmanaged>MFaudioConstrictionOff</unmanaged>
|
|
<unmanaged-short>MFaudioConstrictionOff</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AudioConstriction.MFaudioConstriction4816">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFaudioConstriction48_16']/*"/>
|
|
<unmanaged>MFaudioConstriction48_16</unmanaged>
|
|
<unmanaged-short>MFaudioConstriction48_16</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AudioConstriction.MFaudioConstriction4416">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFaudioConstriction44_16']/*"/>
|
|
<unmanaged>MFaudioConstriction44_16</unmanaged>
|
|
<unmanaged-short>MFaudioConstriction44_16</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AudioConstriction.MFaudioConstriction1414">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFaudioConstriction14_14']/*"/>
|
|
<unmanaged>MFaudioConstriction14_14</unmanaged>
|
|
<unmanaged-short>MFaudioConstriction14_14</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AudioConstriction.MFaudioConstrictionMute">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFaudioConstrictionMute']/*"/>
|
|
<unmanaged>MFaudioConstrictionMute</unmanaged>
|
|
<unmanaged-short>MFaudioConstrictionMute</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Buffer2DLockFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF2DBuffer_LockFlags']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MF2DBuffer_LockFlags</unmanaged>
|
|
<unmanaged-short>MF2DBuffer_LockFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Buffer2DLockFlags.LockTypeMask">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF2DBuffer_LockFlags_LockTypeMask']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MF2DBuffer_LockFlags_LockTypeMask</unmanaged>
|
|
<unmanaged-short>MF2DBuffer_LockFlags_LockTypeMask</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Buffer2DLockFlags.Read">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF2DBuffer_LockFlags_Read']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MF2DBuffer_LockFlags_Read</unmanaged>
|
|
<unmanaged-short>MF2DBuffer_LockFlags_Read</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Buffer2DLockFlags.Write">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF2DBuffer_LockFlags_Write']/*"/>
|
|
<unmanaged>MF2DBuffer_LockFlags_Write</unmanaged>
|
|
<unmanaged-short>MF2DBuffer_LockFlags_Write</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Buffer2DLockFlags.ReadWrite">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF2DBuffer_LockFlags_ReadWrite']/*"/>
|
|
<unmanaged>MF2DBuffer_LockFlags_ReadWrite</unmanaged>
|
|
<unmanaged-short>MF2DBuffer_LockFlags_ReadWrite</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.BytestreamSeekOrigin">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Specifies the origin for a seek request.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBYTESTREAM_SEEK_ORIGIN']/*"/>
|
|
<msdn-id>ms702091</msdn-id>
|
|
<unmanaged>MFBYTESTREAM_SEEK_ORIGIN</unmanaged>
|
|
<unmanaged-short>MFBYTESTREAM_SEEK_ORIGIN</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.BytestreamSeekOrigin.MsoBegin">
|
|
<summary>
|
|
<dd> <p>The seek position is specified relative to the start of the stream.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='msoBegin']/*"/>
|
|
<msdn-id>ms702091</msdn-id>
|
|
<unmanaged>msoBegin</unmanaged>
|
|
<unmanaged-short>msoBegin</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.BytestreamSeekOrigin.MsoCurrent">
|
|
<summary>
|
|
<dd> <p>The seek position is specified relative to the current read/write position in the stream.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='msoCurrent']/*"/>
|
|
<msdn-id>ms702091</msdn-id>
|
|
<unmanaged>msoCurrent</unmanaged>
|
|
<unmanaged-short>msoCurrent</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ClockCharacteristicsFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_CHARACTERISTICS_FLAGS']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFCLOCK_CHARACTERISTICS_FLAGS</unmanaged>
|
|
<unmanaged-short>MFCLOCK_CHARACTERISTICS_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockCharacteristicsFlags.Frequency10mhz">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_CHARACTERISTICS_FLAG_FREQUENCY_10MHZ']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFCLOCK_CHARACTERISTICS_FLAG_FREQUENCY_10MHZ</unmanaged>
|
|
<unmanaged-short>MFCLOCK_CHARACTERISTICS_FLAG_FREQUENCY_10MHZ</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockCharacteristicsFlags.AlwaysRunning">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_CHARACTERISTICS_FLAG_ALWAYS_RUNNING']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFCLOCK_CHARACTERISTICS_FLAG_ALWAYS_RUNNING</unmanaged>
|
|
<unmanaged-short>MFCLOCK_CHARACTERISTICS_FLAG_ALWAYS_RUNNING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockCharacteristicsFlags.IsSystemClock">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_CHARACTERISTICS_FLAG_IS_SYSTEM_CLOCK']/*"/>
|
|
<unmanaged>MFCLOCK_CHARACTERISTICS_FLAG_IS_SYSTEM_CLOCK</unmanaged>
|
|
<unmanaged-short>MFCLOCK_CHARACTERISTICS_FLAG_IS_SYSTEM_CLOCK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockCharacteristicsFlags.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.MediaFoundation.ClockRelationalFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_RELATIONAL_FLAGS']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFCLOCK_RELATIONAL_FLAGS</unmanaged>
|
|
<unmanaged-short>MFCLOCK_RELATIONAL_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockRelationalFlags.JitterNeverAhead">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_RELATIONAL_FLAG_JITTER_NEVER_AHEAD']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFCLOCK_RELATIONAL_FLAG_JITTER_NEVER_AHEAD</unmanaged>
|
|
<unmanaged-short>MFCLOCK_RELATIONAL_FLAG_JITTER_NEVER_AHEAD</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockRelationalFlags.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.MediaFoundation.ClockState">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_STATE']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFCLOCK_STATE</unmanaged>
|
|
<unmanaged-short>MFCLOCK_STATE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockState.Invalid">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_STATE_INVALID']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFCLOCK_STATE_INVALID</unmanaged>
|
|
<unmanaged-short>MFCLOCK_STATE_INVALID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockState.Running">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_STATE_RUNNING']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFCLOCK_STATE_RUNNING</unmanaged>
|
|
<unmanaged-short>MFCLOCK_STATE_RUNNING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockState.Stopped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_STATE_STOPPED']/*"/>
|
|
<unmanaged>MFCLOCK_STATE_STOPPED</unmanaged>
|
|
<unmanaged-short>MFCLOCK_STATE_STOPPED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockState.Paused">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_STATE_PAUSED']/*"/>
|
|
<unmanaged>MFCLOCK_STATE_PAUSED</unmanaged>
|
|
<unmanaged-short>MFCLOCK_STATE_PAUSED</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ConnectMethod">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Specifies how the topology loader connects a topology node. This enumeration is used with the <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.ConnectMethod"/></strong> attribute. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_CONNECT_METHOD']/*"/>
|
|
<msdn-id>ms700178</msdn-id>
|
|
<unmanaged>MF_CONNECT_METHOD</unmanaged>
|
|
<unmanaged-short>MF_CONNECT_METHOD</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ConnectMethod.Direct">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_CONNECT_DIRECT']/*"/>
|
|
<unmanaged>MF_CONNECT_DIRECT</unmanaged>
|
|
<unmanaged-short>MF_CONNECT_DIRECT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ConnectMethod.AllowConverter">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_CONNECT_ALLOW_CONVERTER']/*"/>
|
|
<unmanaged>MF_CONNECT_ALLOW_CONVERTER</unmanaged>
|
|
<unmanaged-short>MF_CONNECT_ALLOW_CONVERTER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ConnectMethod.AllowDecoder">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_CONNECT_ALLOW_DECODER']/*"/>
|
|
<unmanaged>MF_CONNECT_ALLOW_DECODER</unmanaged>
|
|
<unmanaged-short>MF_CONNECT_ALLOW_DECODER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ConnectMethod.ResolveIndependentOutputtypes">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_CONNECT_RESOLVE_INDEPENDENT_OUTPUTTYPES']/*"/>
|
|
<unmanaged>MF_CONNECT_RESOLVE_INDEPENDENT_OUTPUTTYPES</unmanaged>
|
|
<unmanaged-short>MF_CONNECT_RESOLVE_INDEPENDENT_OUTPUTTYPES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ConnectMethod.AsOptional">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_CONNECT_AS_OPTIONAL']/*"/>
|
|
<unmanaged>MF_CONNECT_AS_OPTIONAL</unmanaged>
|
|
<unmanaged-short>MF_CONNECT_AS_OPTIONAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ConnectMethod.AsOptionalBranch">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_CONNECT_AS_OPTIONAL_BRANCH']/*"/>
|
|
<unmanaged>MF_CONNECT_AS_OPTIONAL_BRANCH</unmanaged>
|
|
<unmanaged-short>MF_CONNECT_AS_OPTIONAL_BRANCH</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.DmoInplaceProcessFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_DMO_INPLACE_PROCESS_FLAGS']/*"/>
|
|
<unmanaged>_DMO_INPLACE_PROCESS_FLAGS</unmanaged>
|
|
<unmanaged-short>_DMO_INPLACE_PROCESS_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInplaceProcessFlags.DmoInplaceNormal">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPLACE_NORMAL']/*"/>
|
|
<unmanaged>DMO_INPLACE_NORMAL</unmanaged>
|
|
<unmanaged-short>DMO_INPLACE_NORMAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInplaceProcessFlags.DmoInplaceZero">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPLACE_ZERO']/*"/>
|
|
<unmanaged>DMO_INPLACE_ZERO</unmanaged>
|
|
<unmanaged-short>DMO_INPLACE_ZERO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInplaceProcessFlags.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.MediaFoundation.DmoInputDataBufferFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_DMO_INPUT_DATA_BUFFER_FLAGS']/*"/>
|
|
<unmanaged>_DMO_INPUT_DATA_BUFFER_FLAGS</unmanaged>
|
|
<unmanaged-short>_DMO_INPUT_DATA_BUFFER_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputDataBufferFlags.DmoInputDataBufferfSyncpoint">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPUT_DATA_BUFFERF_SYNCPOINT']/*"/>
|
|
<unmanaged>DMO_INPUT_DATA_BUFFERF_SYNCPOINT</unmanaged>
|
|
<unmanaged-short>DMO_INPUT_DATA_BUFFERF_SYNCPOINT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputDataBufferFlags.DmoInputDataBufferfTime">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPUT_DATA_BUFFERF_TIME']/*"/>
|
|
<unmanaged>DMO_INPUT_DATA_BUFFERF_TIME</unmanaged>
|
|
<unmanaged-short>DMO_INPUT_DATA_BUFFERF_TIME</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputDataBufferFlags.DmoInputDataBufferfTimelength">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPUT_DATA_BUFFERF_TIMELENGTH']/*"/>
|
|
<unmanaged>DMO_INPUT_DATA_BUFFERF_TIMELENGTH</unmanaged>
|
|
<unmanaged-short>DMO_INPUT_DATA_BUFFERF_TIMELENGTH</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputDataBufferFlags.DmoInputDataBufferfDiscontinuity">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPUT_DATA_BUFFERF_DISCONTINUITY']/*"/>
|
|
<unmanaged>DMO_INPUT_DATA_BUFFERF_DISCONTINUITY</unmanaged>
|
|
<unmanaged-short>DMO_INPUT_DATA_BUFFERF_DISCONTINUITY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputDataBufferFlags.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.MediaFoundation.DmoInputStatusFlags">
|
|
<summary>
|
|
<p>Media Foundation transforms (MFTs) are an evolution of the transform model first introduced with DirectX Media Objects (DMOs). This topic summarizes the main ways in which MFTs differ from DMOs. Read this topic if you are already familiar with the DMO interfaces, or if you want to convert an existing DMO into an MFT.</p><p>This topic contains the following sections:</p><p> </p><ul> <li>Number</li> <li>Format</li> <li>Streaming<ul> <li>Allocating Resources</li> <li>Processing Data</li> <li>Flushing</li> <li>Stream Discontinuities</li> </ul> </li> <li>Miscellaneous</li> <li>Flags<ul> <li>ProcessInput Flags</li> <li>ProcessOutput Flags</li> <li>GetInputStatus Flags</li> <li>GetOutputStatus Flags</li> <li>GetInputStreamInfo Flags</li> <li>GetOutputStreamInfo Flags</li> <li>SetInputType/SetOutputType Flags</li> </ul> </li> <li>Error</li> <li>Creating</li> <li>Related</li> </ul>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_DMO_INPUT_STATUS_FLAGS']/*"/>
|
|
<msdn-id>bb250374</msdn-id>
|
|
<unmanaged>_DMO_INPUT_STATUS_FLAGS</unmanaged>
|
|
<unmanaged-short>_DMO_INPUT_STATUS_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputStatusFlags.DmoInputStatusfAcceptData">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPUT_STATUSF_ACCEPT_DATA']/*"/>
|
|
<unmanaged>DMO_INPUT_STATUSF_ACCEPT_DATA</unmanaged>
|
|
<unmanaged-short>DMO_INPUT_STATUSF_ACCEPT_DATA</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputStatusFlags.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.MediaFoundation.DmoInputStreamInformationFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_DMO_INPUT_STREAM_INFO_FLAGS']/*"/>
|
|
<unmanaged>_DMO_INPUT_STREAM_INFO_FLAGS</unmanaged>
|
|
<unmanaged-short>_DMO_INPUT_STREAM_INFO_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputStreamInformationFlags.DmoInputStreamfWholeSamples">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPUT_STREAMF_WHOLE_SAMPLES']/*"/>
|
|
<unmanaged>DMO_INPUT_STREAMF_WHOLE_SAMPLES</unmanaged>
|
|
<unmanaged-short>DMO_INPUT_STREAMF_WHOLE_SAMPLES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputStreamInformationFlags.DmoInputStreamfSingleSamplePerBuffer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPUT_STREAMF_SINGLE_SAMPLE_PER_BUFFER']/*"/>
|
|
<unmanaged>DMO_INPUT_STREAMF_SINGLE_SAMPLE_PER_BUFFER</unmanaged>
|
|
<unmanaged-short>DMO_INPUT_STREAMF_SINGLE_SAMPLE_PER_BUFFER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputStreamInformationFlags.DmoInputStreamfFixedSampleSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPUT_STREAMF_FIXED_SAMPLE_SIZE']/*"/>
|
|
<unmanaged>DMO_INPUT_STREAMF_FIXED_SAMPLE_SIZE</unmanaged>
|
|
<unmanaged-short>DMO_INPUT_STREAMF_FIXED_SAMPLE_SIZE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputStreamInformationFlags.DmoInputStreamfHoldsBuffers">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_INPUT_STREAMF_HOLDS_BUFFERS']/*"/>
|
|
<unmanaged>DMO_INPUT_STREAMF_HOLDS_BUFFERS</unmanaged>
|
|
<unmanaged-short>DMO_INPUT_STREAMF_HOLDS_BUFFERS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoInputStreamInformationFlags.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.MediaFoundation.DmoOutputDataBufferFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_DMO_OUTPUT_DATA_BUFFER_FLAGS']/*"/>
|
|
<unmanaged>_DMO_OUTPUT_DATA_BUFFER_FLAGS</unmanaged>
|
|
<unmanaged-short>_DMO_OUTPUT_DATA_BUFFER_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputDataBufferFlags.DmoOutputDataBufferfSyncpoint">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_DATA_BUFFERF_SYNCPOINT']/*"/>
|
|
<unmanaged>DMO_OUTPUT_DATA_BUFFERF_SYNCPOINT</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_DATA_BUFFERF_SYNCPOINT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputDataBufferFlags.DmoOutputDataBufferfTime">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_DATA_BUFFERF_TIME']/*"/>
|
|
<unmanaged>DMO_OUTPUT_DATA_BUFFERF_TIME</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_DATA_BUFFERF_TIME</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputDataBufferFlags.DmoOutputDataBufferfTimelength">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_DATA_BUFFERF_TIMELENGTH']/*"/>
|
|
<unmanaged>DMO_OUTPUT_DATA_BUFFERF_TIMELENGTH</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_DATA_BUFFERF_TIMELENGTH</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputDataBufferFlags.DmoOutputDataBufferfDiscontinuity">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_DATA_BUFFERF_DISCONTINUITY']/*"/>
|
|
<unmanaged>DMO_OUTPUT_DATA_BUFFERF_DISCONTINUITY</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_DATA_BUFFERF_DISCONTINUITY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputDataBufferFlags.DmoOutputDataBufferfIncomplete">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_DATA_BUFFERF_INCOMPLETE']/*"/>
|
|
<unmanaged>DMO_OUTPUT_DATA_BUFFERF_INCOMPLETE</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_DATA_BUFFERF_INCOMPLETE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputDataBufferFlags.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.MediaFoundation.DmoOutputStreamInformationFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_DMO_OUTPUT_STREAM_INFO_FLAGS']/*"/>
|
|
<unmanaged>_DMO_OUTPUT_STREAM_INFO_FLAGS</unmanaged>
|
|
<unmanaged-short>_DMO_OUTPUT_STREAM_INFO_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputStreamInformationFlags.DmoOutputStreamfWholeSamples">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_STREAMF_WHOLE_SAMPLES']/*"/>
|
|
<unmanaged>DMO_OUTPUT_STREAMF_WHOLE_SAMPLES</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_STREAMF_WHOLE_SAMPLES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputStreamInformationFlags.DmoOutputStreamfSingleSamplePerBuffer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_STREAMF_SINGLE_SAMPLE_PER_BUFFER']/*"/>
|
|
<unmanaged>DMO_OUTPUT_STREAMF_SINGLE_SAMPLE_PER_BUFFER</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_STREAMF_SINGLE_SAMPLE_PER_BUFFER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputStreamInformationFlags.DmoOutputStreamfFixedSampleSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_STREAMF_FIXED_SAMPLE_SIZE']/*"/>
|
|
<unmanaged>DMO_OUTPUT_STREAMF_FIXED_SAMPLE_SIZE</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_STREAMF_FIXED_SAMPLE_SIZE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputStreamInformationFlags.DmoOutputStreamfDiscardable">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_STREAMF_DISCARDABLE']/*"/>
|
|
<unmanaged>DMO_OUTPUT_STREAMF_DISCARDABLE</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_STREAMF_DISCARDABLE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputStreamInformationFlags.DmoOutputStreamfOptional">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_STREAMF_OPTIONAL']/*"/>
|
|
<unmanaged>DMO_OUTPUT_STREAMF_OPTIONAL</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_STREAMF_OPTIONAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputStreamInformationFlags.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.MediaFoundation.DmoProcessOutputFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_DMO_PROCESS_OUTPUT_FLAGS']/*"/>
|
|
<unmanaged>_DMO_PROCESS_OUTPUT_FLAGS</unmanaged>
|
|
<unmanaged-short>_DMO_PROCESS_OUTPUT_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoProcessOutputFlags.DmoProcessOutputDiscardWhenNoBuffer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER']/*"/>
|
|
<unmanaged>DMO_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER</unmanaged>
|
|
<unmanaged-short>DMO_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoProcessOutputFlags.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.MediaFoundation.DmoQualityStatusFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_DMO_QUALITY_STATUS_FLAGS']/*"/>
|
|
<unmanaged>_DMO_QUALITY_STATUS_FLAGS</unmanaged>
|
|
<unmanaged-short>_DMO_QUALITY_STATUS_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoQualityStatusFlags.DmoQualityStatusEnabled">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_QUALITY_STATUS_ENABLED']/*"/>
|
|
<unmanaged>DMO_QUALITY_STATUS_ENABLED</unmanaged>
|
|
<unmanaged-short>DMO_QUALITY_STATUS_ENABLED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoQualityStatusFlags.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.MediaFoundation.DmoSetTypeFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_DMO_SET_TYPE_FLAGS']/*"/>
|
|
<unmanaged>_DMO_SET_TYPE_FLAGS</unmanaged>
|
|
<unmanaged-short>_DMO_SET_TYPE_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoSetTypeFlags.DmoSetTypefTestOnly">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_SET_TYPEF_TEST_ONLY']/*"/>
|
|
<unmanaged>DMO_SET_TYPEF_TEST_ONLY</unmanaged>
|
|
<unmanaged-short>DMO_SET_TYPEF_TEST_ONLY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoSetTypeFlags.DmoSetTypefClear">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_SET_TYPEF_CLEAR']/*"/>
|
|
<unmanaged>DMO_SET_TYPEF_CLEAR</unmanaged>
|
|
<unmanaged-short>DMO_SET_TYPEF_CLEAR</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoSetTypeFlags.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.MediaFoundation.DmoVideoOutputStreamFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_DMO_VIDEO_OUTPUT_STREAM_FLAGS']/*"/>
|
|
<unmanaged>_DMO_VIDEO_OUTPUT_STREAM_FLAGS</unmanaged>
|
|
<unmanaged-short>_DMO_VIDEO_OUTPUT_STREAM_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoVideoOutputStreamFlags.DmoVosfNeedsPreviousSample">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_VOSF_NEEDS_PREVIOUS_SAMPLE']/*"/>
|
|
<unmanaged>DMO_VOSF_NEEDS_PREVIOUS_SAMPLE</unmanaged>
|
|
<unmanaged-short>DMO_VOSF_NEEDS_PREVIOUS_SAMPLE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoVideoOutputStreamFlags.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.MediaFoundation.EAllocationType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='EAllocationType']/*"/>
|
|
<unmanaged>EAllocationType</unmanaged>
|
|
<unmanaged-short>EAllocationType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EAllocationType.EAllocationTypeDynamic">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='eAllocationTypeDynamic']/*"/>
|
|
<unmanaged>eAllocationTypeDynamic</unmanaged>
|
|
<unmanaged-short>eAllocationTypeDynamic</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EAllocationType.EAllocationTypeRT">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='eAllocationTypeRT']/*"/>
|
|
<unmanaged>eAllocationTypeRT</unmanaged>
|
|
<unmanaged-short>eAllocationTypeRT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EAllocationType.EAllocationTypePageable">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='eAllocationTypePageable']/*"/>
|
|
<unmanaged>eAllocationTypePageable</unmanaged>
|
|
<unmanaged-short>eAllocationTypePageable</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EAllocationType.EAllocationTypeIgnore">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='eAllocationTypeIgnore']/*"/>
|
|
<unmanaged>eAllocationTypeIgnore</unmanaged>
|
|
<unmanaged-short>eAllocationTypeIgnore</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.EVRFilterConfigPrefs">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains flags that are used to configure the Microsoft DirectShow enhanced video renderer (EVR) filter.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='EVRFilterConfigPrefs']/*"/>
|
|
<msdn-id>dd318789</msdn-id>
|
|
<unmanaged>EVRFilterConfigPrefs</unmanaged>
|
|
<unmanaged-short>EVRFilterConfigPrefs</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRFilterConfigPrefs.EnableQoS">
|
|
<summary>
|
|
<dd> <p>Enables dynamic adjustments to video quality during playback.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='EVRFilterConfigPrefs_EnableQoS']/*"/>
|
|
<msdn-id>dd318789</msdn-id>
|
|
<unmanaged>EVRFilterConfigPrefs_EnableQoS</unmanaged>
|
|
<unmanaged-short>EVRFilterConfigPrefs_EnableQoS</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.FileAccessmode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Specifies the requested access mode for opening a file.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_FILE_ACCESSMODE']/*"/>
|
|
<msdn-id>ms696239</msdn-id>
|
|
<unmanaged>MF_FILE_ACCESSMODE</unmanaged>
|
|
<unmanaged-short>MF_FILE_ACCESSMODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileAccessmode.MfAccessmodeRead">
|
|
<summary>
|
|
<dd> <p>Read mode.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ACCESSMODE_READ']/*"/>
|
|
<msdn-id>ms696239</msdn-id>
|
|
<unmanaged>MF_ACCESSMODE_READ</unmanaged>
|
|
<unmanaged-short>MF_ACCESSMODE_READ</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileAccessmode.MfAccessmodeWrite">
|
|
<summary>
|
|
<dd> <p>Write mode.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ACCESSMODE_WRITE']/*"/>
|
|
<msdn-id>ms696239</msdn-id>
|
|
<unmanaged>MF_ACCESSMODE_WRITE</unmanaged>
|
|
<unmanaged-short>MF_ACCESSMODE_WRITE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileAccessmode.MfAccessmodeReadwrite">
|
|
<summary>
|
|
<dd> <p>Read and write mode.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_ACCESSMODE_READWRITE']/*"/>
|
|
<msdn-id>ms696239</msdn-id>
|
|
<unmanaged>MF_ACCESSMODE_READWRITE</unmanaged>
|
|
<unmanaged-short>MF_ACCESSMODE_READWRITE</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.FileFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies the behavior when opening a file. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_FILE_FLAGS']/*"/>
|
|
<msdn-id>ms694926</msdn-id>
|
|
<unmanaged>MF_FILE_FLAGS</unmanaged>
|
|
<unmanaged-short>MF_FILE_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileFlags.FlagsNone">
|
|
<summary>
|
|
<dd> <p> Use the default behavior. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_FILEFLAGS_NONE']/*"/>
|
|
<msdn-id>ms694926</msdn-id>
|
|
<unmanaged>MF_FILEFLAGS_NONE</unmanaged>
|
|
<unmanaged-short>MF_FILEFLAGS_NONE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileFlags.FlagsNobuffering">
|
|
<summary>
|
|
<dd> <p> Open the file with no system caching. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_FILEFLAGS_NOBUFFERING']/*"/>
|
|
<msdn-id>ms694926</msdn-id>
|
|
<unmanaged>MF_FILEFLAGS_NOBUFFERING</unmanaged>
|
|
<unmanaged-short>MF_FILEFLAGS_NOBUFFERING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileFlags.FlagsAllowWriteSharing">
|
|
<summary>
|
|
<dd> <p>Subsequent open operations can have write access to the file. </p> <p><strong>Note</strong>??Requires Windows?7 or later.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_FILEFLAGS_ALLOW_WRITE_SHARING']/*"/>
|
|
<msdn-id>ms694926</msdn-id>
|
|
<unmanaged>MF_FILEFLAGS_ALLOW_WRITE_SHARING</unmanaged>
|
|
<unmanaged-short>MF_FILEFLAGS_ALLOW_WRITE_SHARING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileFlags.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.MediaFoundation.FileOpenmode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates a byte stream that is backed by a temporary local file. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> This function creates a file in the system temporary folder, and then returns a byte stream object for that file. The full path name of the file is storted in the <strong><see cref="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.OriginName"/></strong> attribute. The file is created with the <strong>FILE_FLAG_DELETE_ON_CLOSE</strong> flag, and is deleted after the byte stream is released.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_FILE_OPENMODE']/*"/>
|
|
<msdn-id>ms695209</msdn-id>
|
|
<unmanaged>MF_FILE_OPENMODE</unmanaged>
|
|
<unmanaged-short>MF_FILE_OPENMODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileOpenmode.MfOpenmodeFailIfNotExist">
|
|
<summary>
|
|
<dd> <p> The requested access mode, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileAccessmode"/></strong> enumeration. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPENMODE_FAIL_IF_NOT_EXIST']/*"/>
|
|
<msdn-id>ms695209</msdn-id>
|
|
<unmanaged>MF_OPENMODE_FAIL_IF_NOT_EXIST</unmanaged>
|
|
<unmanaged-short>MF_OPENMODE_FAIL_IF_NOT_EXIST</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileOpenmode.MfOpenmodeFailIfExist">
|
|
<summary>
|
|
<dd> <p> The behavior of the function if the file already exists or does not exist, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileOpenmode"/></strong> enumeration. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPENMODE_FAIL_IF_EXIST']/*"/>
|
|
<msdn-id>ms695209</msdn-id>
|
|
<unmanaged>MF_OPENMODE_FAIL_IF_EXIST</unmanaged>
|
|
<unmanaged-short>MF_OPENMODE_FAIL_IF_EXIST</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileOpenmode.MfOpenmodeResetIfExist">
|
|
<summary>
|
|
<dd> <p> Bitwise <strong>OR</strong> of values from the <strong><see cref="T:SharpDX.MediaFoundation.FileFlags"/></strong> enumeration. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPENMODE_RESET_IF_EXIST']/*"/>
|
|
<msdn-id>ms695209</msdn-id>
|
|
<unmanaged>MF_OPENMODE_RESET_IF_EXIST</unmanaged>
|
|
<unmanaged-short>MF_OPENMODE_RESET_IF_EXIST</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileOpenmode.MfOpenmodeAppendIfExist">
|
|
<summary>
|
|
<dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of the byte stream. The caller must release the interface. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPENMODE_APPEND_IF_EXIST']/*"/>
|
|
<msdn-id>ms695209</msdn-id>
|
|
<unmanaged>MF_OPENMODE_APPEND_IF_EXIST</unmanaged>
|
|
<unmanaged-short>MF_OPENMODE_APPEND_IF_EXIST</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FileOpenmode.MfOpenmodeDeleteIfExist">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPENMODE_DELETE_IF_EXIST']/*"/>
|
|
<unmanaged>MF_OPENMODE_DELETE_IF_EXIST</unmanaged>
|
|
<unmanaged-short>MF_OPENMODE_DELETE_IF_EXIST</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaEventTypes">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='__MIDL___MIDL_itf_mfobjects_0000_0012_0001']/*"/>
|
|
<unmanaged>__MIDL___MIDL_itf_mfobjects_0000_0012_0001</unmanaged>
|
|
<unmanaged-short>__MIDL___MIDL_itf_mfobjects_0000_0012_0001</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.Unknown">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEUnknown']/*"/>
|
|
<unmanaged>MEUnknown</unmanaged>
|
|
<unmanaged-short>MEUnknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.Error">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEError']/*"/>
|
|
<unmanaged>MEError</unmanaged>
|
|
<unmanaged-short>MEError</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.ExtendedType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEExtendedType']/*"/>
|
|
<unmanaged>MEExtendedType</unmanaged>
|
|
<unmanaged-short>MEExtendedType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.NonFatalError">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MENonFatalError']/*"/>
|
|
<unmanaged>MENonFatalError</unmanaged>
|
|
<unmanaged-short>MENonFatalError</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.GenericV1Anchor">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEGenericV1Anchor']/*"/>
|
|
<unmanaged>MEGenericV1Anchor</unmanaged>
|
|
<unmanaged-short>MEGenericV1Anchor</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionUnknown">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionUnknown']/*"/>
|
|
<unmanaged>MESessionUnknown</unmanaged>
|
|
<unmanaged-short>MESessionUnknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologySet">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionTopologySet']/*"/>
|
|
<unmanaged>MESessionTopologySet</unmanaged>
|
|
<unmanaged-short>MESessionTopologySet</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologiesCleared">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionTopologiesCleared']/*"/>
|
|
<unmanaged>MESessionTopologiesCleared</unmanaged>
|
|
<unmanaged-short>MESessionTopologiesCleared</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionStarted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionStarted']/*"/>
|
|
<unmanaged>MESessionStarted</unmanaged>
|
|
<unmanaged-short>MESessionStarted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionPaused">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionPaused']/*"/>
|
|
<unmanaged>MESessionPaused</unmanaged>
|
|
<unmanaged-short>MESessionPaused</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionStopped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionStopped']/*"/>
|
|
<unmanaged>MESessionStopped</unmanaged>
|
|
<unmanaged-short>MESessionStopped</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionClosed">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionClosed']/*"/>
|
|
<unmanaged>MESessionClosed</unmanaged>
|
|
<unmanaged-short>MESessionClosed</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionEnded">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionEnded']/*"/>
|
|
<unmanaged>MESessionEnded</unmanaged>
|
|
<unmanaged-short>MESessionEnded</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionRateChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionRateChanged']/*"/>
|
|
<unmanaged>MESessionRateChanged</unmanaged>
|
|
<unmanaged-short>MESessionRateChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionScrubSampleComplete">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionScrubSampleComplete']/*"/>
|
|
<unmanaged>MESessionScrubSampleComplete</unmanaged>
|
|
<unmanaged-short>MESessionScrubSampleComplete</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionCapabilitiesChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionCapabilitiesChanged']/*"/>
|
|
<unmanaged>MESessionCapabilitiesChanged</unmanaged>
|
|
<unmanaged-short>MESessionCapabilitiesChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologyStatus">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionTopologyStatus']/*"/>
|
|
<unmanaged>MESessionTopologyStatus</unmanaged>
|
|
<unmanaged-short>MESessionTopologyStatus</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionNotifyPresentationTime">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionNotifyPresentationTime']/*"/>
|
|
<unmanaged>MESessionNotifyPresentationTime</unmanaged>
|
|
<unmanaged-short>MESessionNotifyPresentationTime</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.NewPresentation">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MENewPresentation']/*"/>
|
|
<unmanaged>MENewPresentation</unmanaged>
|
|
<unmanaged-short>MENewPresentation</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.LicenseAcquisitionStart">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MELicenseAcquisitionStart']/*"/>
|
|
<unmanaged>MELicenseAcquisitionStart</unmanaged>
|
|
<unmanaged-short>MELicenseAcquisitionStart</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.LicenseAcquisitionCompleted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MELicenseAcquisitionCompleted']/*"/>
|
|
<unmanaged>MELicenseAcquisitionCompleted</unmanaged>
|
|
<unmanaged-short>MELicenseAcquisitionCompleted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.IndividualizationStart">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEIndividualizationStart']/*"/>
|
|
<unmanaged>MEIndividualizationStart</unmanaged>
|
|
<unmanaged-short>MEIndividualizationStart</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.IndividualizationCompleted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEIndividualizationCompleted']/*"/>
|
|
<unmanaged>MEIndividualizationCompleted</unmanaged>
|
|
<unmanaged-short>MEIndividualizationCompleted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.EnablerProgress">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEEnablerProgress']/*"/>
|
|
<unmanaged>MEEnablerProgress</unmanaged>
|
|
<unmanaged-short>MEEnablerProgress</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.EnablerCompleted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEEnablerCompleted']/*"/>
|
|
<unmanaged>MEEnablerCompleted</unmanaged>
|
|
<unmanaged-short>MEEnablerCompleted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.PolicyError">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEPolicyError']/*"/>
|
|
<unmanaged>MEPolicyError</unmanaged>
|
|
<unmanaged-short>MEPolicyError</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.PolicyReport">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEPolicyReport']/*"/>
|
|
<unmanaged>MEPolicyReport</unmanaged>
|
|
<unmanaged-short>MEPolicyReport</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStarted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEBufferingStarted']/*"/>
|
|
<unmanaged>MEBufferingStarted</unmanaged>
|
|
<unmanaged-short>MEBufferingStarted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStopped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEBufferingStopped']/*"/>
|
|
<unmanaged>MEBufferingStopped</unmanaged>
|
|
<unmanaged-short>MEBufferingStopped</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.ConnectStart">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEConnectStart']/*"/>
|
|
<unmanaged>MEConnectStart</unmanaged>
|
|
<unmanaged-short>MEConnectStart</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.ConnectEnd">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEConnectEnd']/*"/>
|
|
<unmanaged>MEConnectEnd</unmanaged>
|
|
<unmanaged-short>MEConnectEnd</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.ReconnectStart">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEReconnectStart']/*"/>
|
|
<unmanaged>MEReconnectStart</unmanaged>
|
|
<unmanaged-short>MEReconnectStart</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.ReconnectEnd">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEReconnectEnd']/*"/>
|
|
<unmanaged>MEReconnectEnd</unmanaged>
|
|
<unmanaged-short>MEReconnectEnd</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.RendererEvent">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MERendererEvent']/*"/>
|
|
<unmanaged>MERendererEvent</unmanaged>
|
|
<unmanaged-short>MERendererEvent</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionStreamSinkFormatChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionStreamSinkFormatChanged']/*"/>
|
|
<unmanaged>MESessionStreamSinkFormatChanged</unmanaged>
|
|
<unmanaged-short>MESessionStreamSinkFormatChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SessionV1Anchor">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESessionV1Anchor']/*"/>
|
|
<unmanaged>MESessionV1Anchor</unmanaged>
|
|
<unmanaged-short>MESessionV1Anchor</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SourceUnknown">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESourceUnknown']/*"/>
|
|
<unmanaged>MESourceUnknown</unmanaged>
|
|
<unmanaged-short>MESourceUnknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SourceStarted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESourceStarted']/*"/>
|
|
<unmanaged>MESourceStarted</unmanaged>
|
|
<unmanaged-short>MESourceStarted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamStarted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamStarted']/*"/>
|
|
<unmanaged>MEStreamStarted</unmanaged>
|
|
<unmanaged-short>MEStreamStarted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SourceSeeked">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESourceSeeked']/*"/>
|
|
<unmanaged>MESourceSeeked</unmanaged>
|
|
<unmanaged-short>MESourceSeeked</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSeeked">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSeeked']/*"/>
|
|
<unmanaged>MEStreamSeeked</unmanaged>
|
|
<unmanaged-short>MEStreamSeeked</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.NewStream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MENewStream']/*"/>
|
|
<unmanaged>MENewStream</unmanaged>
|
|
<unmanaged-short>MENewStream</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.UpdatedStream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEUpdatedStream']/*"/>
|
|
<unmanaged>MEUpdatedStream</unmanaged>
|
|
<unmanaged-short>MEUpdatedStream</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SourceStopped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESourceStopped']/*"/>
|
|
<unmanaged>MESourceStopped</unmanaged>
|
|
<unmanaged-short>MESourceStopped</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamStopped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamStopped']/*"/>
|
|
<unmanaged>MEStreamStopped</unmanaged>
|
|
<unmanaged-short>MEStreamStopped</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SourcePaused">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESourcePaused']/*"/>
|
|
<unmanaged>MESourcePaused</unmanaged>
|
|
<unmanaged-short>MESourcePaused</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamPaused">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamPaused']/*"/>
|
|
<unmanaged>MEStreamPaused</unmanaged>
|
|
<unmanaged-short>MEStreamPaused</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.EndOfPresentation">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEEndOfPresentation']/*"/>
|
|
<unmanaged>MEEndOfPresentation</unmanaged>
|
|
<unmanaged-short>MEEndOfPresentation</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.EndOfStream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEEndOfStream']/*"/>
|
|
<unmanaged>MEEndOfStream</unmanaged>
|
|
<unmanaged-short>MEEndOfStream</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.MediaSample">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEMediaSample']/*"/>
|
|
<unmanaged>MEMediaSample</unmanaged>
|
|
<unmanaged-short>MEMediaSample</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamTick">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamTick']/*"/>
|
|
<unmanaged>MEStreamTick</unmanaged>
|
|
<unmanaged-short>MEStreamTick</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamThinMode">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamThinMode']/*"/>
|
|
<unmanaged>MEStreamThinMode</unmanaged>
|
|
<unmanaged-short>MEStreamThinMode</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamFormatChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamFormatChanged']/*"/>
|
|
<unmanaged>MEStreamFormatChanged</unmanaged>
|
|
<unmanaged-short>MEStreamFormatChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SourceRateChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESourceRateChanged']/*"/>
|
|
<unmanaged>MESourceRateChanged</unmanaged>
|
|
<unmanaged-short>MESourceRateChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.EndOfPresentationSegment">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEEndOfPresentationSegment']/*"/>
|
|
<unmanaged>MEEndOfPresentationSegment</unmanaged>
|
|
<unmanaged-short>MEEndOfPresentationSegment</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SourceCharacteristicsChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESourceCharacteristicsChanged']/*"/>
|
|
<unmanaged>MESourceCharacteristicsChanged</unmanaged>
|
|
<unmanaged-short>MESourceCharacteristicsChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SourceRateChangeRequested">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESourceRateChangeRequested']/*"/>
|
|
<unmanaged>MESourceRateChangeRequested</unmanaged>
|
|
<unmanaged-short>MESourceRateChangeRequested</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SourceMetadataChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESourceMetadataChanged']/*"/>
|
|
<unmanaged>MESourceMetadataChanged</unmanaged>
|
|
<unmanaged-short>MESourceMetadataChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SequencerSourceTopologyUpdated">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESequencerSourceTopologyUpdated']/*"/>
|
|
<unmanaged>MESequencerSourceTopologyUpdated</unmanaged>
|
|
<unmanaged-short>MESequencerSourceTopologyUpdated</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SourceV1Anchor">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESourceV1Anchor']/*"/>
|
|
<unmanaged>MESourceV1Anchor</unmanaged>
|
|
<unmanaged-short>MESourceV1Anchor</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SinkUnknown">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESinkUnknown']/*"/>
|
|
<unmanaged>MESinkUnknown</unmanaged>
|
|
<unmanaged-short>MESinkUnknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkStarted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSinkStarted']/*"/>
|
|
<unmanaged>MEStreamSinkStarted</unmanaged>
|
|
<unmanaged-short>MEStreamSinkStarted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkStopped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSinkStopped']/*"/>
|
|
<unmanaged>MEStreamSinkStopped</unmanaged>
|
|
<unmanaged-short>MEStreamSinkStopped</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkPaused">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSinkPaused']/*"/>
|
|
<unmanaged>MEStreamSinkPaused</unmanaged>
|
|
<unmanaged-short>MEStreamSinkPaused</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkRateChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSinkRateChanged']/*"/>
|
|
<unmanaged>MEStreamSinkRateChanged</unmanaged>
|
|
<unmanaged-short>MEStreamSinkRateChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkRequestSample">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSinkRequestSample']/*"/>
|
|
<unmanaged>MEStreamSinkRequestSample</unmanaged>
|
|
<unmanaged-short>MEStreamSinkRequestSample</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkMarker">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSinkMarker']/*"/>
|
|
<unmanaged>MEStreamSinkMarker</unmanaged>
|
|
<unmanaged-short>MEStreamSinkMarker</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkPrerolled">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSinkPrerolled']/*"/>
|
|
<unmanaged>MEStreamSinkPrerolled</unmanaged>
|
|
<unmanaged-short>MEStreamSinkPrerolled</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkScrubSampleComplete">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSinkScrubSampleComplete']/*"/>
|
|
<unmanaged>MEStreamSinkScrubSampleComplete</unmanaged>
|
|
<unmanaged-short>MEStreamSinkScrubSampleComplete</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkFormatChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSinkFormatChanged']/*"/>
|
|
<unmanaged>MEStreamSinkFormatChanged</unmanaged>
|
|
<unmanaged-short>MEStreamSinkFormatChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkDeviceChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEStreamSinkDeviceChanged']/*"/>
|
|
<unmanaged>MEStreamSinkDeviceChanged</unmanaged>
|
|
<unmanaged-short>MEStreamSinkDeviceChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.QualityNotify">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEQualityNotify']/*"/>
|
|
<unmanaged>MEQualityNotify</unmanaged>
|
|
<unmanaged-short>MEQualityNotify</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SinkInvalidated">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESinkInvalidated']/*"/>
|
|
<unmanaged>MESinkInvalidated</unmanaged>
|
|
<unmanaged-short>MESinkInvalidated</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionNameChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEAudioSessionNameChanged']/*"/>
|
|
<unmanaged>MEAudioSessionNameChanged</unmanaged>
|
|
<unmanaged-short>MEAudioSessionNameChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionVolumeChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEAudioSessionVolumeChanged']/*"/>
|
|
<unmanaged>MEAudioSessionVolumeChanged</unmanaged>
|
|
<unmanaged-short>MEAudioSessionVolumeChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionDeviceRemoved">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEAudioSessionDeviceRemoved']/*"/>
|
|
<unmanaged>MEAudioSessionDeviceRemoved</unmanaged>
|
|
<unmanaged-short>MEAudioSessionDeviceRemoved</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionServerShutdown">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEAudioSessionServerShutdown']/*"/>
|
|
<unmanaged>MEAudioSessionServerShutdown</unmanaged>
|
|
<unmanaged-short>MEAudioSessionServerShutdown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionGroupingParamChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEAudioSessionGroupingParamChanged']/*"/>
|
|
<unmanaged>MEAudioSessionGroupingParamChanged</unmanaged>
|
|
<unmanaged-short>MEAudioSessionGroupingParamChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionIconChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEAudioSessionIconChanged']/*"/>
|
|
<unmanaged>MEAudioSessionIconChanged</unmanaged>
|
|
<unmanaged-short>MEAudioSessionIconChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionFormatChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEAudioSessionFormatChanged']/*"/>
|
|
<unmanaged>MEAudioSessionFormatChanged</unmanaged>
|
|
<unmanaged-short>MEAudioSessionFormatChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionDisconnected">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEAudioSessionDisconnected']/*"/>
|
|
<unmanaged>MEAudioSessionDisconnected</unmanaged>
|
|
<unmanaged-short>MEAudioSessionDisconnected</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionExclusiveModeOverride">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEAudioSessionExclusiveModeOverride']/*"/>
|
|
<unmanaged>MEAudioSessionExclusiveModeOverride</unmanaged>
|
|
<unmanaged-short>MEAudioSessionExclusiveModeOverride</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SinkV1Anchor">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESinkV1Anchor']/*"/>
|
|
<unmanaged>MESinkV1Anchor</unmanaged>
|
|
<unmanaged-short>MESinkV1Anchor</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.CaptureAudioSessionVolumeChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MECaptureAudioSessionVolumeChanged']/*"/>
|
|
<unmanaged>MECaptureAudioSessionVolumeChanged</unmanaged>
|
|
<unmanaged-short>MECaptureAudioSessionVolumeChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.CaptureAudioSessionDeviceRemoved">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MECaptureAudioSessionDeviceRemoved']/*"/>
|
|
<unmanaged>MECaptureAudioSessionDeviceRemoved</unmanaged>
|
|
<unmanaged-short>MECaptureAudioSessionDeviceRemoved</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.CaptureAudioSessionFormatChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MECaptureAudioSessionFormatChanged']/*"/>
|
|
<unmanaged>MECaptureAudioSessionFormatChanged</unmanaged>
|
|
<unmanaged-short>MECaptureAudioSessionFormatChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.CaptureAudioSessionDisconnected">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MECaptureAudioSessionDisconnected']/*"/>
|
|
<unmanaged>MECaptureAudioSessionDisconnected</unmanaged>
|
|
<unmanaged-short>MECaptureAudioSessionDisconnected</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.CaptureAudioSessionExclusiveModeOverride">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MECaptureAudioSessionExclusiveModeOverride']/*"/>
|
|
<unmanaged>MECaptureAudioSessionExclusiveModeOverride</unmanaged>
|
|
<unmanaged-short>MECaptureAudioSessionExclusiveModeOverride</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.CaptureAudioSessionServerShutdown">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MECaptureAudioSessionServerShutdown']/*"/>
|
|
<unmanaged>MECaptureAudioSessionServerShutdown</unmanaged>
|
|
<unmanaged-short>MECaptureAudioSessionServerShutdown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.SinkV2Anchor">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MESinkV2Anchor']/*"/>
|
|
<unmanaged>MESinkV2Anchor</unmanaged>
|
|
<unmanaged-short>MESinkV2Anchor</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.TrustUnknown">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='METrustUnknown']/*"/>
|
|
<unmanaged>METrustUnknown</unmanaged>
|
|
<unmanaged-short>METrustUnknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.PolicyChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEPolicyChanged']/*"/>
|
|
<unmanaged>MEPolicyChanged</unmanaged>
|
|
<unmanaged-short>MEPolicyChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.ContentProtectionMessage">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEContentProtectionMessage']/*"/>
|
|
<unmanaged>MEContentProtectionMessage</unmanaged>
|
|
<unmanaged-short>MEContentProtectionMessage</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.PolicySet">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEPolicySet']/*"/>
|
|
<unmanaged>MEPolicySet</unmanaged>
|
|
<unmanaged-short>MEPolicySet</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.TrustV1Anchor">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='METrustV1Anchor']/*"/>
|
|
<unmanaged>METrustV1Anchor</unmanaged>
|
|
<unmanaged-short>METrustV1Anchor</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMLicenseBackupCompleted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMLicenseBackupCompleted']/*"/>
|
|
<unmanaged>MEWMDRMLicenseBackupCompleted</unmanaged>
|
|
<unmanaged-short>MEWMDRMLicenseBackupCompleted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMLicenseBackupProgress">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMLicenseBackupProgress']/*"/>
|
|
<unmanaged>MEWMDRMLicenseBackupProgress</unmanaged>
|
|
<unmanaged-short>MEWMDRMLicenseBackupProgress</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMLicenseRestoreCompleted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMLicenseRestoreCompleted']/*"/>
|
|
<unmanaged>MEWMDRMLicenseRestoreCompleted</unmanaged>
|
|
<unmanaged-short>MEWMDRMLicenseRestoreCompleted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMLicenseRestoreProgress">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMLicenseRestoreProgress']/*"/>
|
|
<unmanaged>MEWMDRMLicenseRestoreProgress</unmanaged>
|
|
<unmanaged-short>MEWMDRMLicenseRestoreProgress</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMLicenseAcquisitionCompleted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMLicenseAcquisitionCompleted']/*"/>
|
|
<unmanaged>MEWMDRMLicenseAcquisitionCompleted</unmanaged>
|
|
<unmanaged-short>MEWMDRMLicenseAcquisitionCompleted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMIndividualizationCompleted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMIndividualizationCompleted']/*"/>
|
|
<unmanaged>MEWMDRMIndividualizationCompleted</unmanaged>
|
|
<unmanaged-short>MEWMDRMIndividualizationCompleted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMIndividualizationProgress">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMIndividualizationProgress']/*"/>
|
|
<unmanaged>MEWMDRMIndividualizationProgress</unmanaged>
|
|
<unmanaged-short>MEWMDRMIndividualizationProgress</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMProximityCompleted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMProximityCompleted']/*"/>
|
|
<unmanaged>MEWMDRMProximityCompleted</unmanaged>
|
|
<unmanaged-short>MEWMDRMProximityCompleted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMLicenseStoreCleaned">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMLicenseStoreCleaned']/*"/>
|
|
<unmanaged>MEWMDRMLicenseStoreCleaned</unmanaged>
|
|
<unmanaged-short>MEWMDRMLicenseStoreCleaned</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMRevocationDownloadCompleted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMRevocationDownloadCompleted']/*"/>
|
|
<unmanaged>MEWMDRMRevocationDownloadCompleted</unmanaged>
|
|
<unmanaged-short>MEWMDRMRevocationDownloadCompleted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.WindowsMediaDRMV1Anchor">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEWMDRMV1Anchor']/*"/>
|
|
<unmanaged>MEWMDRMV1Anchor</unmanaged>
|
|
<unmanaged-short>MEWMDRMV1Anchor</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.TransformUnknown">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='METransformUnknown']/*"/>
|
|
<unmanaged>METransformUnknown</unmanaged>
|
|
<unmanaged-short>METransformUnknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.TransformNeedInput">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='METransformNeedInput']/*"/>
|
|
<unmanaged>METransformNeedInput</unmanaged>
|
|
<unmanaged-short>METransformNeedInput</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.TransformHaveOutput">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='METransformHaveOutput']/*"/>
|
|
<unmanaged>METransformHaveOutput</unmanaged>
|
|
<unmanaged-short>METransformHaveOutput</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.TransformDrainComplete">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='METransformDrainComplete']/*"/>
|
|
<unmanaged>METransformDrainComplete</unmanaged>
|
|
<unmanaged-short>METransformDrainComplete</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.TransformMarker">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='METransformMarker']/*"/>
|
|
<unmanaged>METransformMarker</unmanaged>
|
|
<unmanaged-short>METransformMarker</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.ByteStreamCharacteristicsChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEByteStreamCharacteristicsChanged']/*"/>
|
|
<unmanaged>MEByteStreamCharacteristicsChanged</unmanaged>
|
|
<unmanaged-short>MEByteStreamCharacteristicsChanged</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.VideoCaptureDeviceRemoved">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEVideoCaptureDeviceRemoved']/*"/>
|
|
<unmanaged>MEVideoCaptureDeviceRemoved</unmanaged>
|
|
<unmanaged-short>MEVideoCaptureDeviceRemoved</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.VideoCaptureDevicePreempted">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEVideoCaptureDevicePreempted']/*"/>
|
|
<unmanaged>MEVideoCaptureDevicePreempted</unmanaged>
|
|
<unmanaged-short>MEVideoCaptureDevicePreempted</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaEventTypes.ReservedMax">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MEReservedMax']/*"/>
|
|
<unmanaged>MEReservedMax</unmanaged>
|
|
<unmanaged-short>MEReservedMax</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediasourceCharacteristics">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Defines the characteristics of a media source. These flags are retrieved by the <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.GetCharacteristics(System.Int32@)"/></strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To skip forward or backward in a playlist, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Start(SharpDX.MediaFoundation.PresentationDescriptor,System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.Start(System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong> with the <strong>MF_TIME_FORMAT_ENTRY_RELATIVE</strong> time-format <see cref="T:System.Guid"/>. This capability applies only when the <strong><see cref="F:SharpDX.MediaFoundation.MediasourceCharacteristics.HasMultiplePresentations"/></strong> flag is present.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMEDIASOURCE_CHARACTERISTICS']/*"/>
|
|
<msdn-id>ms694277</msdn-id>
|
|
<unmanaged>MFMEDIASOURCE_CHARACTERISTICS</unmanaged>
|
|
<unmanaged-short>MFMEDIASOURCE_CHARACTERISTICS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediasourceCharacteristics.IsLive">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMEDIASOURCE_IS_LIVE']/*"/>
|
|
<unmanaged>MFMEDIASOURCE_IS_LIVE</unmanaged>
|
|
<unmanaged-short>MFMEDIASOURCE_IS_LIVE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediasourceCharacteristics.CanSeek">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMEDIASOURCE_CAN_SEEK']/*"/>
|
|
<unmanaged>MFMEDIASOURCE_CAN_SEEK</unmanaged>
|
|
<unmanaged-short>MFMEDIASOURCE_CAN_SEEK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediasourceCharacteristics.CanPause">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMEDIASOURCE_CAN_PAUSE']/*"/>
|
|
<unmanaged>MFMEDIASOURCE_CAN_PAUSE</unmanaged>
|
|
<unmanaged-short>MFMEDIASOURCE_CAN_PAUSE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediasourceCharacteristics.HasSlowSeek">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMEDIASOURCE_HAS_SLOW_SEEK']/*"/>
|
|
<unmanaged>MFMEDIASOURCE_HAS_SLOW_SEEK</unmanaged>
|
|
<unmanaged-short>MFMEDIASOURCE_HAS_SLOW_SEEK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediasourceCharacteristics.HasMultiplePresentations">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMEDIASOURCE_HAS_MULTIPLE_PRESENTATIONS']/*"/>
|
|
<unmanaged>MFMEDIASOURCE_HAS_MULTIPLE_PRESENTATIONS</unmanaged>
|
|
<unmanaged-short>MFMEDIASOURCE_HAS_MULTIPLE_PRESENTATIONS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediasourceCharacteristics.CanSkipforward">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMEDIASOURCE_CAN_SKIPFORWARD']/*"/>
|
|
<unmanaged>MFMEDIASOURCE_CAN_SKIPFORWARD</unmanaged>
|
|
<unmanaged-short>MFMEDIASOURCE_CAN_SKIPFORWARD</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediasourceCharacteristics.CanSkipbackward">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMEDIASOURCE_CAN_SKIPBACKWARD']/*"/>
|
|
<unmanaged>MFMEDIASOURCE_CAN_SKIPBACKWARD</unmanaged>
|
|
<unmanaged-short>MFMEDIASOURCE_CAN_SKIPBACKWARD</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MfpCreationOptions">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Contains flags that define the behavior of the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong> function. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFP_CREATION_OPTIONS']/*"/>
|
|
<msdn-id>ms697495</msdn-id>
|
|
<unmanaged>_MFP_CREATION_OPTIONS</unmanaged>
|
|
<unmanaged-short>_MFP_CREATION_OPTIONS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCreationOptions.MfpOptionNone">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_OPTION_NONE']/*"/>
|
|
<unmanaged>MFP_OPTION_NONE</unmanaged>
|
|
<unmanaged-short>MFP_OPTION_NONE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCreationOptions.MfpOptionFreeThreadedCallback">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_OPTION_FREE_THREADED_CALLBACK']/*"/>
|
|
<unmanaged>MFP_OPTION_FREE_THREADED_CALLBACK</unmanaged>
|
|
<unmanaged-short>MFP_OPTION_FREE_THREADED_CALLBACK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCreationOptions.MfpOptionNoMmcss">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_OPTION_NO_MMCSS']/*"/>
|
|
<unmanaged>MFP_OPTION_NO_MMCSS</unmanaged>
|
|
<unmanaged-short>MFP_OPTION_NO_MMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCreationOptions.MfpOptionNoRemoteDesktopOptimization">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_OPTION_NO_REMOTE_DESKTOP_OPTIMIZATION']/*"/>
|
|
<unmanaged>MFP_OPTION_NO_REMOTE_DESKTOP_OPTIMIZATION</unmanaged>
|
|
<unmanaged-short>MFP_OPTION_NO_REMOTE_DESKTOP_OPTIMIZATION</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MfpCredentialFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Contains flags that define the behavior of the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong> function. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFP_CREDENTIAL_FLAGS']/*"/>
|
|
<msdn-id>ms697495</msdn-id>
|
|
<unmanaged>_MFP_CREDENTIAL_FLAGS</unmanaged>
|
|
<unmanaged-short>_MFP_CREDENTIAL_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCredentialFlags.MfpCredentialPrompt">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_CREDENTIAL_PROMPT']/*"/>
|
|
<unmanaged>MFP_CREDENTIAL_PROMPT</unmanaged>
|
|
<unmanaged-short>MFP_CREDENTIAL_PROMPT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCredentialFlags.MfpCredentialSave">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_CREDENTIAL_SAVE']/*"/>
|
|
<unmanaged>MFP_CREDENTIAL_SAVE</unmanaged>
|
|
<unmanaged-short>MFP_CREDENTIAL_SAVE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCredentialFlags.MfpCredentialDoNotCache">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_CREDENTIAL_DO_NOT_CACHE']/*"/>
|
|
<unmanaged>MFP_CREDENTIAL_DO_NOT_CACHE</unmanaged>
|
|
<unmanaged-short>MFP_CREDENTIAL_DO_NOT_CACHE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCredentialFlags.MfpCredentialClearText">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_CREDENTIAL_CLEAR_TEXT']/*"/>
|
|
<unmanaged>MFP_CREDENTIAL_CLEAR_TEXT</unmanaged>
|
|
<unmanaged-short>MFP_CREDENTIAL_CLEAR_TEXT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCredentialFlags.MfpCredentialProxy">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_CREDENTIAL_PROXY']/*"/>
|
|
<unmanaged>MFP_CREDENTIAL_PROXY</unmanaged>
|
|
<unmanaged-short>MFP_CREDENTIAL_PROXY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCredentialFlags.MfpCredentialLoggedOnUser">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_CREDENTIAL_LOGGED_ON_USER']/*"/>
|
|
<unmanaged>MFP_CREDENTIAL_LOGGED_ON_USER</unmanaged>
|
|
<unmanaged-short>MFP_CREDENTIAL_LOGGED_ON_USER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpCredentialFlags.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.MediaFoundation.MfpMediaitemCharacteristics">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Defines the characteristics of a media source. These flags are retrieved by the <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.GetCharacteristics(System.Int32@)"/></strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To skip forward or backward in a playlist, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Start(SharpDX.MediaFoundation.PresentationDescriptor,System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.Start(System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong> with the <strong>MF_TIME_FORMAT_ENTRY_RELATIVE</strong> time-format <see cref="T:System.Guid"/>. This capability applies only when the <strong><see cref="F:SharpDX.MediaFoundation.MediasourceCharacteristics.HasMultiplePresentations"/></strong> flag is present.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFP_MEDIAITEM_CHARACTERISTICS']/*"/>
|
|
<msdn-id>ms694277</msdn-id>
|
|
<unmanaged>_MFP_MEDIAITEM_CHARACTERISTICS</unmanaged>
|
|
<unmanaged-short>_MFP_MEDIAITEM_CHARACTERISTICS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpMediaitemCharacteristics.MfpMediaitemIsLive">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_IS_LIVE']/*"/>
|
|
<unmanaged>MFP_MEDIAITEM_IS_LIVE</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAITEM_IS_LIVE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpMediaitemCharacteristics.MfpMediaitemCanSeek">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_CAN_SEEK']/*"/>
|
|
<unmanaged>MFP_MEDIAITEM_CAN_SEEK</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAITEM_CAN_SEEK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpMediaitemCharacteristics.MfpMediaitemCanPause">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_CAN_PAUSE']/*"/>
|
|
<unmanaged>MFP_MEDIAITEM_CAN_PAUSE</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAITEM_CAN_PAUSE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MfpMediaitemCharacteristics.MfpMediaitemHasSlowSeek">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_HAS_SLOW_SEEK']/*"/>
|
|
<unmanaged>MFP_MEDIAITEM_HAS_SLOW_SEEK</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAITEM_HAS_SLOW_SEEK</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MftDrainType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Defines messages for an enhanced video renderer (EVR) presenter. This enumeration is used with the <strong><see cref="M:SharpDX.MediaFoundation.VideoPresenter.ProcessMessage(SharpDX.MediaFoundation.VpMessageType,System.IntPtr)"/></strong> method.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_DRAIN_TYPE']/*"/>
|
|
<msdn-id>ms698964</msdn-id>
|
|
<unmanaged>_MFT_DRAIN_TYPE</unmanaged>
|
|
<unmanaged-short>_MFT_DRAIN_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftDrainType.MftDrainProduceTails">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_DRAIN_PRODUCE_TAILS']/*"/>
|
|
<unmanaged>MFT_DRAIN_PRODUCE_TAILS</unmanaged>
|
|
<unmanaged-short>MFT_DRAIN_PRODUCE_TAILS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftDrainType.MftDrainNoTails">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_DRAIN_NO_TAILS']/*"/>
|
|
<unmanaged>MFT_DRAIN_NO_TAILS</unmanaged>
|
|
<unmanaged-short>MFT_DRAIN_NO_TAILS</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MftEnumFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains flags for registering and enumeration Media Foundation transforms (MFTs).</p><p>These flags are used in the following functions:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong>: These flags control which Media Foundation transforms (MFTs) are enumerated, as well as the enumeration order.</li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegister(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],SharpDX.MediaFoundation.MediaAttributes)"/></strong>: A subset of these flags are used when registering an MFT.</li> </ul>
|
|
</summary>
|
|
<remarks>
|
|
<p>For registration, these flags describe the MFT that is being registered. Some flags do not apply in that context. For enumeration, these flags control which MFTs are selected in the enumeration. For more details about the precise meaning of these flags, see the reference topics for <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegister(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],SharpDX.MediaFoundation.MediaAttributes)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> </p><p>For registration, the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSyncmft"/></strong>, <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsAsyncmft"/></strong>, and <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsHardware"/></strong> flags are mutually exclusive. For enumeration, these three flags can be combined.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_ENUM_FLAG']/*"/>
|
|
<msdn-id>dd389302</msdn-id>
|
|
<unmanaged>_MFT_ENUM_FLAG</unmanaged>
|
|
<unmanaged-short>_MFT_ENUM_FLAG</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSyncmft">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_ENUM_FLAG_SYNCMFT']/*"/>
|
|
<unmanaged>MFT_ENUM_FLAG_SYNCMFT</unmanaged>
|
|
<unmanaged-short>MFT_ENUM_FLAG_SYNCMFT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsAsyncmft">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_ENUM_FLAG_ASYNCMFT']/*"/>
|
|
<unmanaged>MFT_ENUM_FLAG_ASYNCMFT</unmanaged>
|
|
<unmanaged-short>MFT_ENUM_FLAG_ASYNCMFT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsHardware">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_ENUM_FLAG_HARDWARE']/*"/>
|
|
<unmanaged>MFT_ENUM_FLAG_HARDWARE</unmanaged>
|
|
<unmanaged-short>MFT_ENUM_FLAG_HARDWARE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsFieldofuse">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_ENUM_FLAG_FIELDOFUSE']/*"/>
|
|
<unmanaged>MFT_ENUM_FLAG_FIELDOFUSE</unmanaged>
|
|
<unmanaged-short>MFT_ENUM_FLAG_FIELDOFUSE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsLocalmft">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_ENUM_FLAG_LOCALMFT']/*"/>
|
|
<unmanaged>MFT_ENUM_FLAG_LOCALMFT</unmanaged>
|
|
<unmanaged-short>MFT_ENUM_FLAG_LOCALMFT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsTranscodeOnly">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_ENUM_FLAG_TRANSCODE_ONLY']/*"/>
|
|
<unmanaged>MFT_ENUM_FLAG_TRANSCODE_ONLY</unmanaged>
|
|
<unmanaged-short>MFT_ENUM_FLAG_TRANSCODE_ONLY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSortandfilter">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_ENUM_FLAG_SORTANDFILTER']/*"/>
|
|
<unmanaged>MFT_ENUM_FLAG_SORTANDFILTER</unmanaged>
|
|
<unmanaged-short>MFT_ENUM_FLAG_SORTANDFILTER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSortandfilterApprovedOnly">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_ENUM_FLAG_SORTANDFILTER_APPROVED_ONLY']/*"/>
|
|
<unmanaged>MFT_ENUM_FLAG_SORTANDFILTER_APPROVED_ONLY</unmanaged>
|
|
<unmanaged-short>MFT_ENUM_FLAG_SORTANDFILTER_APPROVED_ONLY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSortandfilterWebOnly">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_ENUM_FLAG_SORTANDFILTER_WEB_ONLY']/*"/>
|
|
<unmanaged>MFT_ENUM_FLAG_SORTANDFILTER_WEB_ONLY</unmanaged>
|
|
<unmanaged-short>MFT_ENUM_FLAG_SORTANDFILTER_WEB_ONLY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsAll">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_ENUM_FLAG_ALL']/*"/>
|
|
<unmanaged>MFT_ENUM_FLAG_ALL</unmanaged>
|
|
<unmanaged-short>MFT_ENUM_FLAG_ALL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftEnumFlags.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.MediaFoundation.MftInputDataBufferFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Defines flags for the <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong> method. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The values in this enumeration are not bit flags, so they should not be combined with a bitwise <strong>OR</strong>. Also, the caller should test for these flags with the equality operator, not a bitwise <strong>AND</strong>:</p><code>// Correct.
|
|
if (Buffer.dwStatus == <see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferStreamEnd"/>)
|
|
{ ...
|
|
} // Incorrect.
|
|
if ((Buffer.dwStatus & <see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferStreamEnd"/>) != 0)
|
|
{ ...
|
|
}
|
|
</code>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_INPUT_DATA_BUFFER_FLAGS']/*"/>
|
|
<msdn-id>ms702281</msdn-id>
|
|
<unmanaged>_MFT_INPUT_DATA_BUFFER_FLAGS</unmanaged>
|
|
<unmanaged-short>_MFT_INPUT_DATA_BUFFER_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputDataBufferFlags.MftInputDataBufferPlaceholder">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_DATA_BUFFER_PLACEHOLDER']/*"/>
|
|
<unmanaged>MFT_INPUT_DATA_BUFFER_PLACEHOLDER</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_DATA_BUFFER_PLACEHOLDER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputDataBufferFlags.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.MediaFoundation.MftInputStatusFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Describes the current status of a call to the <strong><see cref="M:SharpDX.MediaFoundation.Shutdownable.Shutdown"/></strong> method.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_INPUT_STATUS_FLAGS']/*"/>
|
|
<msdn-id>ms701630</msdn-id>
|
|
<unmanaged>_MFT_INPUT_STATUS_FLAGS</unmanaged>
|
|
<unmanaged-short>_MFT_INPUT_STATUS_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStatusFlags.MftInputStatusAcceptData">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STATUS_ACCEPT_DATA']/*"/>
|
|
<unmanaged>MFT_INPUT_STATUS_ACCEPT_DATA</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_STATUS_ACCEPT_DATA</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStatusFlags.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.MediaFoundation.MftInputStreamInformationFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Defines flags for the <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong> method. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The values in this enumeration are not bit flags, so they should not be combined with a bitwise <strong>OR</strong>. Also, the caller should test for these flags with the equality operator, not a bitwise <strong>AND</strong>:</p><code>// Correct.
|
|
if (Buffer.dwStatus == <see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferStreamEnd"/>)
|
|
{ ...
|
|
} // Incorrect.
|
|
if ((Buffer.dwStatus & <see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferStreamEnd"/>) != 0)
|
|
{ ...
|
|
}
|
|
</code>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_INPUT_STREAM_INFO_FLAGS']/*"/>
|
|
<msdn-id>ms702281</msdn-id>
|
|
<unmanaged>_MFT_INPUT_STREAM_INFO_FLAGS</unmanaged>
|
|
<unmanaged-short>_MFT_INPUT_STREAM_INFO_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.MftInputStreamWholeSamples">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_WHOLE_SAMPLES']/*"/>
|
|
<unmanaged>MFT_INPUT_STREAM_WHOLE_SAMPLES</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_STREAM_WHOLE_SAMPLES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.MftInputStreamSingleSamplePerBuffer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_SINGLE_SAMPLE_PER_BUFFER']/*"/>
|
|
<unmanaged>MFT_INPUT_STREAM_SINGLE_SAMPLE_PER_BUFFER</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_STREAM_SINGLE_SAMPLE_PER_BUFFER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.MftInputStreamFixedSampleSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_FIXED_SAMPLE_SIZE']/*"/>
|
|
<unmanaged>MFT_INPUT_STREAM_FIXED_SAMPLE_SIZE</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_STREAM_FIXED_SAMPLE_SIZE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.MftInputStreamHoldsBuffers">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_HOLDS_BUFFERS']/*"/>
|
|
<unmanaged>MFT_INPUT_STREAM_HOLDS_BUFFERS</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_STREAM_HOLDS_BUFFERS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.MftInputStreamDoesNotAddref">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_DOES_NOT_ADDREF']/*"/>
|
|
<unmanaged>MFT_INPUT_STREAM_DOES_NOT_ADDREF</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_STREAM_DOES_NOT_ADDREF</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.MftInputStreamRemovable">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_REMOVABLE']/*"/>
|
|
<unmanaged>MFT_INPUT_STREAM_REMOVABLE</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_STREAM_REMOVABLE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.MftInputStreamOptional">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_OPTIONAL']/*"/>
|
|
<unmanaged>MFT_INPUT_STREAM_OPTIONAL</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_STREAM_OPTIONAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.MftInputStreamProcessesInPlace">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_PROCESSES_IN_PLACE']/*"/>
|
|
<unmanaged>MFT_INPUT_STREAM_PROCESSES_IN_PLACE</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_STREAM_PROCESSES_IN_PLACE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.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.MediaFoundation.MftOutputDataBufferFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Defines flags for the <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong> method. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The values in this enumeration are not bit flags, so they should not be combined with a bitwise <strong>OR</strong>. Also, the caller should test for these flags with the equality operator, not a bitwise <strong>AND</strong>:</p><code>// Correct.
|
|
if (Buffer.dwStatus == <see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferStreamEnd"/>)
|
|
{ ...
|
|
} // Incorrect.
|
|
if ((Buffer.dwStatus & <see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferStreamEnd"/>) != 0)
|
|
{ ...
|
|
}
|
|
</code>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_OUTPUT_DATA_BUFFER_FLAGS']/*"/>
|
|
<msdn-id>ms702281</msdn-id>
|
|
<unmanaged>_MFT_OUTPUT_DATA_BUFFER_FLAGS</unmanaged>
|
|
<unmanaged-short>_MFT_OUTPUT_DATA_BUFFER_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferIncomplete">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_DATA_BUFFER_INCOMPLETE']/*"/>
|
|
<unmanaged>MFT_OUTPUT_DATA_BUFFER_INCOMPLETE</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_DATA_BUFFER_INCOMPLETE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferFormatChange">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_DATA_BUFFER_FORMAT_CHANGE']/*"/>
|
|
<unmanaged>MFT_OUTPUT_DATA_BUFFER_FORMAT_CHANGE</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_DATA_BUFFER_FORMAT_CHANGE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferStreamEnd">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_DATA_BUFFER_STREAM_END']/*"/>
|
|
<unmanaged>MFT_OUTPUT_DATA_BUFFER_STREAM_END</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_DATA_BUFFER_STREAM_END</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferNoSample">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_DATA_BUFFER_NO_SAMPLE']/*"/>
|
|
<unmanaged>MFT_OUTPUT_DATA_BUFFER_NO_SAMPLE</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_DATA_BUFFER_NO_SAMPLE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.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.MediaFoundation.MftOutputStatusFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Indicates whether a Media Foundation transform (MFT) can produce output data.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_OUTPUT_STATUS_FLAGS']/*"/>
|
|
<msdn-id>ms701553</msdn-id>
|
|
<unmanaged>_MFT_OUTPUT_STATUS_FLAGS</unmanaged>
|
|
<unmanaged-short>_MFT_OUTPUT_STATUS_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStatusFlags.MftOutputStatusSampleReady">
|
|
<summary>
|
|
<dd> <p>There is a sample available for at least one output stream. To retrieve the available output samples, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong>.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STATUS_SAMPLE_READY']/*"/>
|
|
<msdn-id>ms701553</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STATUS_SAMPLE_READY</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STATUS_SAMPLE_READY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStatusFlags.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.MediaFoundation.MftOutputStreamInformationFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Describes an output stream on a Media Foundation transform (MFT).</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Before the client sets the media types on the MFT, the only flag guaranteed to be accurate is the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamOptional"/> flag. For all other flags, the client should first set the media type on every non-optional stream.</p><p>The <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamDiscardable"/> and <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamLazyRead"/> flags define different behaviors for how the MFT can discard output data.</p><ul> <li> <p>MFT_OUTPUT_STREAM_DISCARDABLE: The MFT discards output data only if the client calls <strong>ProcessOutput</strong> with the <see cref="F:SharpDX.MediaFoundation.MftProcessOutputFlags.MftProcessOutputDiscardWhenNoBuffer"/> flag. The MFT never discards data when the client calls <strong>ProcessInput</strong>.</p> </li> <li> <p>MFT_OUTPUT_STREAM_LAZY_READ: If the client continues to call <strong>ProcessInput</strong> without collecting the output from this stream, the MFT eventually discards the output. If all output streams have the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamLazyRead"/> flag, the MFT never refuses more input data.</p> </li> </ul><p>If neither of these flags is set, the MFT never discards output data.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_OUTPUT_STREAM_INFO_FLAGS']/*"/>
|
|
<msdn-id>ms705618</msdn-id>
|
|
<unmanaged>_MFT_OUTPUT_STREAM_INFO_FLAGS</unmanaged>
|
|
<unmanaged-short>_MFT_OUTPUT_STREAM_INFO_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamWholeSamples">
|
|
<summary>
|
|
<dd> <p>Each media sample (<strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface) of output data from the MFT contains complete, unbroken units of data. The definition of a <em>unit of data</em> depends on the media type: For uncompressed video, a video frame; for compressed data, a compressed packet; for uncompressed audio, a single audio frame.</p> <p>For uncompressed audio formats, this flag is always implied. (It is valid to set the flag, but not required.) An uncompressed audio frame should never span more than one media sample.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_WHOLE_SAMPLES']/*"/>
|
|
<msdn-id>ms705618</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STREAM_WHOLE_SAMPLES</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STREAM_WHOLE_SAMPLES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamSingleSamplePerBuffer">
|
|
<summary>
|
|
<dd> <p>Each output sample contains exactly one unit of data, as defined for the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamWholeSamples"/> flag.</p> <p>If this flag is present, the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamWholeSamples"/> flag must also be present.</p> <p>An MFT that outputs uncompressed audio should not set this flag. For efficiency, it should output more than one audio frame at a time.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_SINGLE_SAMPLE_PER_BUFFER']/*"/>
|
|
<msdn-id>ms705618</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STREAM_SINGLE_SAMPLE_PER_BUFFER</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STREAM_SINGLE_SAMPLE_PER_BUFFER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamFixedSampleSize">
|
|
<summary>
|
|
<dd> <p>All output samples are the same size.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_FIXED_SAMPLE_SIZE']/*"/>
|
|
<msdn-id>ms705618</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STREAM_FIXED_SAMPLE_SIZE</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STREAM_FIXED_SAMPLE_SIZE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamDiscardable">
|
|
<summary>
|
|
<dd> <p>The MFT can discard the output data from this output stream, if requested by the client. To discard the output, set the <see cref="F:SharpDX.MediaFoundation.MftProcessOutputFlags.MftProcessOutputDiscardWhenNoBuffer"/> flag in the <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong> method.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_DISCARDABLE']/*"/>
|
|
<msdn-id>ms705618</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STREAM_DISCARDABLE</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STREAM_DISCARDABLE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamOptional">
|
|
<summary>
|
|
<dd> <p>This output stream is optional. The client can deselect the stream by not setting a media type or by setting a <strong><c>null</c></strong> media type. When an optional stream is deselected, it does not produce any output data.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_OPTIONAL']/*"/>
|
|
<msdn-id>ms705618</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STREAM_OPTIONAL</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STREAM_OPTIONAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamProvidesSamples">
|
|
<summary>
|
|
<dd> <p>The MFT provides the output samples for this stream, either by allocating them internally or by operating directly on the input samples. The MFT cannot use output samples provided by the client for this stream.</p> <p>If this flag is not set, the MFT must set <strong>cbSize</strong> to a nonzero value in the <strong><see cref="T:SharpDX.MediaFoundation.TOutputStreamInformation"/></strong> structure, so that the client can allocate the correct buffer size. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputStreamInfo(System.Int32,SharpDX.MediaFoundation.TOutputStreamInformation@)"/></strong>. This flag cannot be combined with the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamCanProvideSamples"/> flag.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_PROVIDES_SAMPLES']/*"/>
|
|
<msdn-id>ms705618</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STREAM_PROVIDES_SAMPLES</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STREAM_PROVIDES_SAMPLES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamCanProvideSamples">
|
|
<summary>
|
|
<dd> <p>The MFT can either provide output samples for this stream or it can use samples that the client allocates. This flag cannot be combined with the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamProvidesSamples"/> flag.</p> <p>If the MFT does not set this flag or the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamProvidesSamples"/> flag, the client must allocate the samples for this output stream. The MFT will not provide its own samples.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_CAN_PROVIDE_SAMPLES']/*"/>
|
|
<msdn-id>ms705618</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STREAM_CAN_PROVIDE_SAMPLES</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STREAM_CAN_PROVIDE_SAMPLES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamLazyRead">
|
|
<summary>
|
|
<dd> <p>The MFT does not require the client to process the output for this stream. If the client continues to send input data without getting the output from this stream, the MFT simply discards the previous input.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_LAZY_READ']/*"/>
|
|
<msdn-id>ms705618</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STREAM_LAZY_READ</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STREAM_LAZY_READ</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamRemovable">
|
|
<summary>
|
|
<dd> <p>The MFT might remove this output stream during streaming. This flag typically applies to demultiplexers, where the input data contains multiple streams that can start and stop during streaming. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong>.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_REMOVABLE']/*"/>
|
|
<msdn-id>ms705618</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STREAM_REMOVABLE</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STREAM_REMOVABLE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.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.MediaFoundation.MftProcessOutputFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Defines flags for the <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong> method. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The values in this enumeration are not bit flags, so they should not be combined with a bitwise <strong>OR</strong>. Also, the caller should test for these flags with the equality operator, not a bitwise <strong>AND</strong>:</p><code>// Correct.
|
|
if (Buffer.dwStatus == <see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferStreamEnd"/>)
|
|
{ ...
|
|
} // Incorrect.
|
|
if ((Buffer.dwStatus & <see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferStreamEnd"/>) != 0)
|
|
{ ...
|
|
}
|
|
</code>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_PROCESS_OUTPUT_FLAGS']/*"/>
|
|
<msdn-id>ms702281</msdn-id>
|
|
<unmanaged>_MFT_PROCESS_OUTPUT_FLAGS</unmanaged>
|
|
<unmanaged-short>_MFT_PROCESS_OUTPUT_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftProcessOutputFlags.MftProcessOutputDiscardWhenNoBuffer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER']/*"/>
|
|
<unmanaged>MFT_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER</unmanaged>
|
|
<unmanaged-short>MFT_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftProcessOutputFlags.MftProcessOutputRegenerateLastOutput">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_PROCESS_OUTPUT_REGENERATE_LAST_OUTPUT']/*"/>
|
|
<unmanaged>MFT_PROCESS_OUTPUT_REGENERATE_LAST_OUTPUT</unmanaged>
|
|
<unmanaged-short>MFT_PROCESS_OUTPUT_REGENERATE_LAST_OUTPUT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftProcessOutputFlags.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.MediaFoundation.MftProcessOutputStatus">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Indicates the status of a call to <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong>.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the MFT sets this flag, the <strong>ProcessOutput</strong> method returns MF_E_TRANSFORM_STREAM_CHANGE and no output data is produced. The client should respond as follows:</p><ol> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamCount(System.Int32@,System.Int32@)"/></strong> to get the new number of streams.</p> </li> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong> to get the new stream identifiers.</p> </li> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputAvailableType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType@)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.Transform.SetOutputType(System.Int32,SharpDX.MediaFoundation.MediaType,System.Int32)"/></strong> to set the media types on the new streams.</p> </li> </ol><p>Until these steps are completed, all further calls to <strong>ProcessOutput</strong> return MF_E_TRANSFORM_STREAM_CHANGE.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_PROCESS_OUTPUT_STATUS']/*"/>
|
|
<msdn-id>ms699875</msdn-id>
|
|
<unmanaged>_MFT_PROCESS_OUTPUT_STATUS</unmanaged>
|
|
<unmanaged-short>_MFT_PROCESS_OUTPUT_STATUS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftProcessOutputStatus.MftProcessOutputStatusNewStreams">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_PROCESS_OUTPUT_STATUS_NEW_STREAMS']/*"/>
|
|
<unmanaged>MFT_PROCESS_OUTPUT_STATUS_NEW_STREAMS</unmanaged>
|
|
<unmanaged-short>MFT_PROCESS_OUTPUT_STATUS_NEW_STREAMS</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MftSetTypeFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines flags for the setting or testing the media type on a Media Foundation transform (MFT).</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='_MFT_SET_TYPE_FLAGS']/*"/>
|
|
<msdn-id>ms704051</msdn-id>
|
|
<unmanaged>_MFT_SET_TYPE_FLAGS</unmanaged>
|
|
<unmanaged-short>_MFT_SET_TYPE_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftSetTypeFlags.MftSetTypeTestOnly">
|
|
<summary>
|
|
<dd> <p>Test the proposed media type, but do not set it.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_SET_TYPE_TEST_ONLY']/*"/>
|
|
<msdn-id>ms704051</msdn-id>
|
|
<unmanaged>MFT_SET_TYPE_TEST_ONLY</unmanaged>
|
|
<unmanaged-short>MFT_SET_TYPE_TEST_ONLY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MftSetTypeFlags.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.MediaFoundation.MidlMidlItfMfreadwrite000000010002">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='__MIDL___MIDL_itf_mfreadwrite_0000_0001_0002']/*"/>
|
|
<unmanaged>__MIDL___MIDL_itf_mfreadwrite_0000_0001_0002</unmanaged>
|
|
<unmanaged-short>__MIDL___MIDL_itf_mfreadwrite_0000_0001_0002</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MidlMidlItfMfreadwrite000000010002.CurrentTypeIndex">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READER_CURRENT_TYPE_INDEX']/*"/>
|
|
<unmanaged>MF_SOURCE_READER_CURRENT_TYPE_INDEX</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READER_CURRENT_TYPE_INDEX</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetAuthenticationFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetAuthenticationFlags']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFNetAuthenticationFlags</unmanaged>
|
|
<unmanaged-short>MFNetAuthenticationFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetAuthenticationFlags.MfnetAuthenticationProxy">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_AUTHENTICATION_PROXY']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFNET_AUTHENTICATION_PROXY</unmanaged>
|
|
<unmanaged-short>MFNET_AUTHENTICATION_PROXY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetAuthenticationFlags.MfnetAuthenticationClearText">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_AUTHENTICATION_CLEAR_TEXT']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFNET_AUTHENTICATION_CLEAR_TEXT</unmanaged>
|
|
<unmanaged-short>MFNET_AUTHENTICATION_CLEAR_TEXT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetAuthenticationFlags.MfnetAuthenticationLoggedOnUser">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_AUTHENTICATION_LOGGED_ON_USER']/*"/>
|
|
<unmanaged>MFNET_AUTHENTICATION_LOGGED_ON_USER</unmanaged>
|
|
<unmanaged-short>MFNET_AUTHENTICATION_LOGGED_ON_USER</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetCredentialOptions">
|
|
<summary>
|
|
<p>Media Foundation provides a default implementation of the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialCache"/></strong> interface. An application that implements the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface can use the default credential cache object to store the user's credentials.</p><p>To create the default credential cache object, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateCredentialCache(SharpDX.MediaFoundation.NetCredentialCache@)"/></strong> function.</p><pre><code><see cref="T:SharpDX.Result"/> hr = <see cref="F:SharpDX.Result.Ok"/>;
|
|
<see cref="T:SharpDX.MediaFoundation.NetCredentialCache"/> *pCredentialCache = <c>null</c>;
|
|
hr = <see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateCredentialCache(SharpDX.MediaFoundation.NetCredentialCache@)"/>(&pCredentialCache);
|
|
</code></pre><p>After the credential cache is created, the application can use the following methods to get a credential object, set user credentials, and specify the caching options.</p><ul> <li> <p>To get the credential object for a URL, call <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.GetCredential(System.String,System.String,System.Int32,SharpDX.MediaFoundation.NetCredential@,System.Int32@)"/></strong>.</p> <pre><code>hr = pCredentialCache-> GetCredential( pszUrl, pszRealm, dwAuthenticationFlags, &pCredential, &dwRequirementsFlags);
|
|
</code></pre> <p>If the credentials for the specified URL do not exist in the credential cache, <strong>GetCredential</strong> creates a new credential object with empty user name and password values.</p> </li> <li> To set the user name and password on the credential object, call <strong><see cref="M:SharpDX.MediaFoundation.NetCredential.SetUser(System.Byte[],System.Int32,System.Boolean)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.NetCredential.SetPassword(System.Byte[],System.Int32,System.Boolean)"/></strong>. </li> <li> <p>To set the caching options on the credential object, call <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.</p> <pre><code>hr = pCredentialCache-> SetUserOptions( pCredentialCache, <see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialSave"/>);
|
|
</code></pre> <p>The <em>dwOptionsFlags</em> parameter values are defined in the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialOptions"/></strong> enumeration. To save user credentials for a URL in a persistent storage, set the <see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialSave"/> flag. If the <strong>SetUserOptions</strong> call completes successfully, then the subsequent call to <strong>GetCredential</strong> searches for the credentials in the persistent storage. If a match is found, this method returns a reference to the credential object that contains the information.</p> <p>By default, user credentials sent over the network are encrypted. To change this to clear text, set the <see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/> flag.</p> <p>To remove information from the registry, call <strong>GetCredential</strong> to get the credential object, and then call <strong>SetUserOption</strong> and set <em>dwOptionsFlags</em> to <see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialDontCache"/>.</p> </li> </ul>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialOptions']/*"/>
|
|
<msdn-id>ee318418</msdn-id>
|
|
<unmanaged>MFNetCredentialOptions</unmanaged>
|
|
<unmanaged-short>MFNetCredentialOptions</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialSave">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_CREDENTIAL_SAVE']/*"/>
|
|
<unmanaged>MFNET_CREDENTIAL_SAVE</unmanaged>
|
|
<unmanaged-short>MFNET_CREDENTIAL_SAVE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialDontCache">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_CREDENTIAL_DONT_CACHE']/*"/>
|
|
<unmanaged>MFNET_CREDENTIAL_DONT_CACHE</unmanaged>
|
|
<unmanaged-short>MFNET_CREDENTIAL_DONT_CACHE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_CREDENTIAL_ALLOW_CLEAR_TEXT']/*"/>
|
|
<unmanaged>MFNET_CREDENTIAL_ALLOW_CLEAR_TEXT</unmanaged>
|
|
<unmanaged-short>MFNET_CREDENTIAL_ALLOW_CLEAR_TEXT</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetCredentialRequirements">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialRequirements']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFNetCredentialRequirements</unmanaged>
|
|
<unmanaged-short>MFNetCredentialRequirements</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='REQUIRE_PROMPT']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>REQUIRE_PROMPT</unmanaged>
|
|
<unmanaged-short>REQUIRE_PROMPT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequireSaveSelected">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='REQUIRE_SAVE_SELECTED']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>REQUIRE_SAVE_SELECTED</unmanaged>
|
|
<unmanaged-short>REQUIRE_SAVE_SELECTED</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetProxysettings">
|
|
<summary>
|
|
<p>This topic describes the configuration settings for the default proxy locator. For information about creating the proxy locator with custom configuration settings, see How to Configure the Proxy Locator.</p><p>The proxy locator can be configured to operate in three modes: <em>manual mode</em>, <em>auto-detect mode</em>, and <em>browser mode</em>. The values are defined in <strong><see cref="T:SharpDX.MediaFoundation.NetProxysettings"/></strong> enumeration. The application can configure the mode by setting the <strong>MFNETSOURCE_PROXYSETTINGS</strong> property. The proxy locator can also be configured not to use a proxy server by setting this property to <strong><see cref="F:SharpDX.MediaFoundation.NetProxysettings.None"/></strong>. The proxy server is not used if the media server is a local host or the application requests a class A address (127.x.x.x)?reserved for loopback tests.</p><p><strong>Caution</strong>??A proxy server is a security barrier between your intranet and the Internet. Not using a proxy server can expose the network to security threats.</p><ul> <li> <p>Manual Mode. The application sets this mode by setting the <strong>MFNETSOURCE_PROXYSETTING</strong> property to <strong><see cref="F:SharpDX.MediaFoundation.NetProxysettings.Manual"/></strong>. The application must specify the following connection information:</p> <ul> <li> Hostname of the proxy server: <strong>MFNETSOURCE_PROXYHOSTNAME</strong> property. </li> <li> Port number: <strong>MFNETSOURCE_PROXYPORT</strong> property. </li> <li> <p>Whether to use a proxy server for local addresses: <strong>MFNETSOURCE_PROXYBYPASSFORLOCAL</strong> property. This setting is optional. If this is not specified, then the proxy locator uses a default value of <strong><see cref="F:SharpDX.Result.False"/></strong>.</p> <p><strong>Note</strong>??By bypassing the proxy server, the application might be able to connect to media servers on the intranet faster.</p> </li> <li> List of media server addresses that do not require a proxy server to establish a connection: <strong>MFNETSOURCE_PROXYEXCEPTIONLIST</strong> property. This setting is optional. </li> </ul> </li> <li> <p>Auto-Detect Mode. The application sets this mode by setting the <strong>MFNETSOURCE_PROXYSETTING</strong> property to <strong><see cref="F:SharpDX.MediaFoundation.NetProxysettings.Auto"/></strong>. In this mode, the proxy locator uses the WinHTTP AutoProxy mechanism to get the hostname and the port number for the proxy server. This connection information is retrieved by using the WPAD auto proxy script, which is configured by the domain administrator. For more information about this mechanism, see the Microsoft website.</p> <p>The proxy locator caches the connection information in the registry. In subsequent proxy detection calls, the proxy locator reads proxy information from the registry cache to reduce the overhead involved in auto detection. However, the application can force auto proxy redetection by setting the <strong>MFNETSOURCE_PROXYRERUNAUTODETECTION</strong> property.</p> </li> <li> Browser Mode. The application sets this mode by setting the <strong>MFNETSOURCE_PROXYSETTING</strong> property to <strong><see cref="F:SharpDX.MediaFoundation.NetProxysettings.Browser"/></strong>. In this mode, the proxy locator uses the proxy settings of the browser application. This mode is set by default if the protocol is HTTP or HTTPD. </li> </ul>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_PROXYSETTINGS']/*"/>
|
|
<msdn-id>aa374814</msdn-id>
|
|
<unmanaged>MFNET_PROXYSETTINGS</unmanaged>
|
|
<unmanaged-short>MFNET_PROXYSETTINGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetProxysettings.None">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_PROXYSETTING_NONE']/*"/>
|
|
<unmanaged>MFNET_PROXYSETTING_NONE</unmanaged>
|
|
<unmanaged-short>MFNET_PROXYSETTING_NONE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetProxysettings.Manual">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_PROXYSETTING_MANUAL']/*"/>
|
|
<unmanaged>MFNET_PROXYSETTING_MANUAL</unmanaged>
|
|
<unmanaged-short>MFNET_PROXYSETTING_MANUAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetProxysettings.Auto">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_PROXYSETTING_AUTO']/*"/>
|
|
<unmanaged>MFNET_PROXYSETTING_AUTO</unmanaged>
|
|
<unmanaged-short>MFNET_PROXYSETTING_AUTO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetProxysettings.Browser">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNET_PROXYSETTING_BROWSER']/*"/>
|
|
<unmanaged>MFNET_PROXYSETTING_BROWSER</unmanaged>
|
|
<unmanaged-short>MFNET_PROXYSETTING_BROWSER</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetsourceCacheState">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines the status of the cache for a media file or entry.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_CACHE_STATE']/*"/>
|
|
<msdn-id>ms705647</msdn-id>
|
|
<unmanaged>MFNETSOURCE_CACHE_STATE</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_CACHE_STATE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceCacheState.Unavailable">
|
|
<summary>
|
|
<dd> <p>The cache for a file or entry does not exist.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_CACHE_UNAVAILABLE']/*"/>
|
|
<msdn-id>ms705647</msdn-id>
|
|
<unmanaged>MFNETSOURCE_CACHE_UNAVAILABLE</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_CACHE_UNAVAILABLE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceCacheState.ActiveWriting">
|
|
<summary>
|
|
<dd> <p>The cache for a file or entry is growing.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_CACHE_ACTIVE_WRITING']/*"/>
|
|
<msdn-id>ms705647</msdn-id>
|
|
<unmanaged>MFNETSOURCE_CACHE_ACTIVE_WRITING</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_CACHE_ACTIVE_WRITING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceCacheState.ActiveComplete">
|
|
<summary>
|
|
<dd> <p>The cache for a file or entry is completed.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_CACHE_ACTIVE_COMPLETE']/*"/>
|
|
<msdn-id>ms705647</msdn-id>
|
|
<unmanaged>MFNETSOURCE_CACHE_ACTIVE_COMPLETE</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_CACHE_ACTIVE_COMPLETE</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetsourceProtocolType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves a supported protocol by index</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_PROTOCOL_TYPE']/*"/>
|
|
<msdn-id>ms697058</msdn-id>
|
|
<unmanaged>MFNETSOURCE_PROTOCOL_TYPE</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_PROTOCOL_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceProtocolType.Undefined">
|
|
<summary>
|
|
<dd> <p>Zero-based index of the protocol to retrieve. To get the number of supported protocols, call <strong><see cref="M:SharpDX.MediaFoundation.NetSchemeHandlerConfig.GetNumberOfSupportedProtocols(System.Int32@)"/></strong>.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_UNDEFINED']/*"/>
|
|
<msdn-id>ms697058</msdn-id>
|
|
<unmanaged>MFNETSOURCE_UNDEFINED</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_UNDEFINED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceProtocolType.Http">
|
|
<summary>
|
|
<dd> <p>Receives a member of the <strong><see cref="T:SharpDX.MediaFoundation.NetsourceProtocolType"/></strong> enumeration.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_HTTP']/*"/>
|
|
<msdn-id>ms697058</msdn-id>
|
|
<unmanaged>MFNETSOURCE_HTTP</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_HTTP</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceProtocolType.Rtsp">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_RTSP']/*"/>
|
|
<unmanaged>MFNETSOURCE_RTSP</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_RTSP</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceProtocolType.File">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_FILE']/*"/>
|
|
<unmanaged>MFNETSOURCE_FILE</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_FILE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceProtocolType.Multicast">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_MULTICAST']/*"/>
|
|
<unmanaged>MFNETSOURCE_MULTICAST</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_MULTICAST</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetsourceStatisticsIds">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Defines statistics collected by the network source. The values in this enumeration define property identifiers (PIDs) for the <strong>MFNETSOURCE_STATISTICS</strong> property.</p><p>To retrieve statistics from the network source, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> with the service identifier <strong>MFNETSOURCE_STATISTICS_SERVICE</strong> and the interface identifier IID_IPropertyStore. The retrieved reference is an <strong><see cref="T:SharpDX.ComObject"/></strong> reference. To get the value of a network statistic, construct a <strong>PROPERTYKEY</strong> with <strong>fmtid</strong> equal to <strong>MFNETSOURCE_STATISTICS</strong> and <strong>pid</strong> equal to a value from this enumeration. Then call <strong>IPropertyStore::GetValue</strong> with the property key to retrieve the value of the statistic as a <strong><see cref="T:SharpDX.Win32.Variant"/></strong>. </p><p>In the descriptions that follow, the data type and value-type tag for the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> are listed in parentheses.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_STATISTICS_IDS']/*"/>
|
|
<msdn-id>ms697019</msdn-id>
|
|
<unmanaged>MFNETSOURCE_STATISTICS_IDS</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_STATISTICS_IDS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.RecvpacketsId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_RECVPACKETS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_RECVPACKETS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_RECVPACKETS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.LostpacketsId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_LOSTPACKETS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_LOSTPACKETS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_LOSTPACKETS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.ResendsrequestedId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_RESENDSREQUESTED_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_RESENDSREQUESTED_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_RESENDSREQUESTED_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.ResendsreceivedId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_RESENDSRECEIVED_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_RESENDSRECEIVED_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_RESENDSRECEIVED_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.RecoveredbyeccpacketsId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_RECOVEREDBYECCPACKETS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_RECOVEREDBYECCPACKETS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_RECOVEREDBYECCPACKETS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.RecoveredbyrtxpacketsId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_RECOVEREDBYRTXPACKETS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_RECOVEREDBYRTXPACKETS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_RECOVEREDBYRTXPACKETS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.OutpacketsId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_OUTPACKETS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_OUTPACKETS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_OUTPACKETS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.RecvrateId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_RECVRATE_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_RECVRATE_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_RECVRATE_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.AvgbandwidthbpsId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_AVGBANDWIDTHBPS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_AVGBANDWIDTHBPS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_AVGBANDWIDTHBPS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.BytesreceivedId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_BYTESRECEIVED_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_BYTESRECEIVED_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_BYTESRECEIVED_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.ProtocolId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_PROTOCOL_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_PROTOCOL_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_PROTOCOL_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.TransportId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_TRANSPORT_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_TRANSPORT_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_TRANSPORT_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.CacheStateId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_CACHE_STATE_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_CACHE_STATE_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_CACHE_STATE_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.LinkbandwidthId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_LINKBANDWIDTH_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_LINKBANDWIDTH_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_LINKBANDWIDTH_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.ContentbitrateId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_CONTENTBITRATE_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_CONTENTBITRATE_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_CONTENTBITRATE_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.SpeedfactorId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_SPEEDFACTOR_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_SPEEDFACTOR_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_SPEEDFACTOR_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.BuffersizeId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_BUFFERSIZE_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_BUFFERSIZE_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_BUFFERSIZE_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.BufferprogressId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_BUFFERPROGRESS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_BUFFERPROGRESS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_BUFFERPROGRESS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.LastbwswitchtsId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_LASTBWSWITCHTS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_LASTBWSWITCHTS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_LASTBWSWITCHTS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.SeekrangestartId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_SEEKRANGESTART_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_SEEKRANGESTART_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_SEEKRANGESTART_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.SeekrangeendId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_SEEKRANGEEND_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_SEEKRANGEEND_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_SEEKRANGEEND_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.BufferingcountId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_BUFFERINGCOUNT_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_BUFFERINGCOUNT_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_BUFFERINGCOUNT_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.IncorrectlysignedpacketsId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_INCORRECTLYSIGNEDPACKETS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_INCORRECTLYSIGNEDPACKETS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_INCORRECTLYSIGNEDPACKETS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.SignedsessionId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_SIGNEDSESSION_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_SIGNEDSESSION_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_SIGNEDSESSION_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.MaxbitrateId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_MAXBITRATE_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_MAXBITRATE_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_MAXBITRATE_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.ReceptionQualityId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_RECEPTION_QUALITY_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_RECEPTION_QUALITY_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_RECEPTION_QUALITY_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.RecoveredpacketsId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_RECOVEREDPACKETS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_RECOVEREDPACKETS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_RECOVEREDPACKETS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.VbrId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_VBR_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_VBR_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_VBR_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.DownloadprogressId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_DOWNLOADPROGRESS_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_DOWNLOADPROGRESS_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_DOWNLOADPROGRESS_ID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceStatisticsIds.UnpredefinedprotocolnameId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_UNPREDEFINEDPROTOCOLNAME_ID']/*"/>
|
|
<unmanaged>MFNETSOURCE_UNPREDEFINEDPROTOCOLNAME_ID</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_UNPREDEFINEDPROTOCOLNAME_ID</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetsourceTransportType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Defines statistics collected by the network source. The values in this enumeration define property identifiers (PIDs) for the <strong>MFNETSOURCE_STATISTICS</strong> property.</p><p>To retrieve statistics from the network source, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> with the service identifier <strong>MFNETSOURCE_STATISTICS_SERVICE</strong> and the interface identifier IID_IPropertyStore. The retrieved reference is an <strong><see cref="T:SharpDX.ComObject"/></strong> reference. To get the value of a network statistic, construct a <strong>PROPERTYKEY</strong> with <strong>fmtid</strong> equal to <strong>MFNETSOURCE_STATISTICS</strong> and <strong>pid</strong> equal to a value from this enumeration. Then call <strong>IPropertyStore::GetValue</strong> with the property key to retrieve the value of the statistic as a <strong><see cref="T:SharpDX.Win32.Variant"/></strong>. </p><p>In the descriptions that follow, the data type and value-type tag for the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> are listed in parentheses.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_TRANSPORT_TYPE']/*"/>
|
|
<msdn-id>ms697019</msdn-id>
|
|
<unmanaged>MFNETSOURCE_TRANSPORT_TYPE</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_TRANSPORT_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceTransportType.Udp">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_UDP']/*"/>
|
|
<unmanaged>MFNETSOURCE_UDP</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_UDP</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetsourceTransportType.Tcp">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNETSOURCE_TCP']/*"/>
|
|
<unmanaged>MFNETSOURCE_TCP</unmanaged>
|
|
<unmanaged-short>MFNETSOURCE_TCP</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NominalRange">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNominalRange']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFNominalRange</unmanaged>
|
|
<unmanaged-short>MFNominalRange</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NominalRange.Unknown">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNominalRange_Unknown']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFNominalRange_Unknown</unmanaged>
|
|
<unmanaged-short>MFNominalRange_Unknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NominalRange.Normal">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNominalRange_Normal']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFNominalRange_Normal</unmanaged>
|
|
<unmanaged-short>MFNominalRange_Normal</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NominalRange.Wide">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNominalRange_Wide']/*"/>
|
|
<unmanaged>MFNominalRange_Wide</unmanaged>
|
|
<unmanaged-short>MFNominalRange_Wide</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NominalRange.Range0_255">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNominalRange_0_255']/*"/>
|
|
<unmanaged>MFNominalRange_0_255</unmanaged>
|
|
<unmanaged-short>MFNominalRange_0_255</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NominalRange.Range16_235">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNominalRange_16_235']/*"/>
|
|
<unmanaged>MFNominalRange_16_235</unmanaged>
|
|
<unmanaged-short>MFNominalRange_16_235</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NominalRange.Range48_208">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNominalRange_48_208']/*"/>
|
|
<unmanaged>MFNominalRange_48_208</unmanaged>
|
|
<unmanaged-short>MFNominalRange_48_208</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NominalRange.Range64_127">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNominalRange_64_127']/*"/>
|
|
<unmanaged>MFNominalRange_64_127</unmanaged>
|
|
<unmanaged-short>MFNominalRange_64_127</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NominalRange.Last">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNominalRange_Last']/*"/>
|
|
<unmanaged>MFNominalRange_Last</unmanaged>
|
|
<unmanaged-short>MFNominalRange_Last</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NominalRange.ForceDWORD">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNominalRange_ForceDWORD']/*"/>
|
|
<unmanaged>MFNominalRange_ForceDWORD</unmanaged>
|
|
<unmanaged-short>MFNominalRange_ForceDWORD</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ObjectType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Defines the object types that are created by the source resolver.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OBJECT_TYPE']/*"/>
|
|
<msdn-id>ms704771</msdn-id>
|
|
<unmanaged>MF_OBJECT_TYPE</unmanaged>
|
|
<unmanaged-short>MF_OBJECT_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ObjectType.Mediasource">
|
|
<summary>
|
|
<dd> <p>Media source. You can query the object for the <strong><see cref="T:SharpDX.MediaFoundation.MediaSource"/></strong> interface.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OBJECT_MEDIASOURCE']/*"/>
|
|
<msdn-id>ms704771</msdn-id>
|
|
<unmanaged>MF_OBJECT_MEDIASOURCE</unmanaged>
|
|
<unmanaged-short>MF_OBJECT_MEDIASOURCE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ObjectType.Bytestream">
|
|
<summary>
|
|
<dd> <p>Byte stream. You can query the object for the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OBJECT_BYTESTREAM']/*"/>
|
|
<msdn-id>ms704771</msdn-id>
|
|
<unmanaged>MF_OBJECT_BYTESTREAM</unmanaged>
|
|
<unmanaged-short>MF_OBJECT_BYTESTREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ObjectType.Invalid">
|
|
<summary>
|
|
<dd> <p>Invalid type.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OBJECT_INVALID']/*"/>
|
|
<msdn-id>ms704771</msdn-id>
|
|
<unmanaged>MF_OBJECT_INVALID</unmanaged>
|
|
<unmanaged-short>MF_OBJECT_INVALID</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.OpmAcpProtectionLevel">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_ACP_PROTECTION_LEVEL']/*"/>
|
|
<unmanaged>MF_OPM_ACP_PROTECTION_LEVEL</unmanaged>
|
|
<unmanaged-short>MF_OPM_ACP_PROTECTION_LEVEL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmAcpProtectionLevel.Off">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_ACP_OFF']/*"/>
|
|
<unmanaged>MF_OPM_ACP_OFF</unmanaged>
|
|
<unmanaged-short>MF_OPM_ACP_OFF</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmAcpProtectionLevel.LevelOne">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_ACP_LEVEL_ONE']/*"/>
|
|
<unmanaged>MF_OPM_ACP_LEVEL_ONE</unmanaged>
|
|
<unmanaged-short>MF_OPM_ACP_LEVEL_ONE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmAcpProtectionLevel.LevelTwo">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_ACP_LEVEL_TWO']/*"/>
|
|
<unmanaged>MF_OPM_ACP_LEVEL_TWO</unmanaged>
|
|
<unmanaged-short>MF_OPM_ACP_LEVEL_TWO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmAcpProtectionLevel.LevelThree">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_ACP_LEVEL_THREE']/*"/>
|
|
<unmanaged>MF_OPM_ACP_LEVEL_THREE</unmanaged>
|
|
<unmanaged-short>MF_OPM_ACP_LEVEL_THREE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmAcpProtectionLevel.ForceUlong">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_ACP_FORCE_ULONG']/*"/>
|
|
<unmanaged>MF_OPM_ACP_FORCE_ULONG</unmanaged>
|
|
<unmanaged-short>MF_OPM_ACP_FORCE_ULONG</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.OpmCgmsaProtectionLevel">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_CGMSA_PROTECTION_LEVEL']/*"/>
|
|
<unmanaged>MF_OPM_CGMSA_PROTECTION_LEVEL</unmanaged>
|
|
<unmanaged-short>MF_OPM_CGMSA_PROTECTION_LEVEL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmCgmsaProtectionLevel.Off">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_CGMSA_OFF']/*"/>
|
|
<unmanaged>MF_OPM_CGMSA_OFF</unmanaged>
|
|
<unmanaged-short>MF_OPM_CGMSA_OFF</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmCgmsaProtectionLevel.CopyFreely">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_CGMSA_COPY_FREELY']/*"/>
|
|
<unmanaged>MF_OPM_CGMSA_COPY_FREELY</unmanaged>
|
|
<unmanaged-short>MF_OPM_CGMSA_COPY_FREELY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmCgmsaProtectionLevel.CopyNoMore">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_CGMSA_COPY_NO_MORE']/*"/>
|
|
<unmanaged>MF_OPM_CGMSA_COPY_NO_MORE</unmanaged>
|
|
<unmanaged-short>MF_OPM_CGMSA_COPY_NO_MORE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmCgmsaProtectionLevel.CopyOneGeneration">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_CGMSA_COPY_ONE_GENERATION']/*"/>
|
|
<unmanaged>MF_OPM_CGMSA_COPY_ONE_GENERATION</unmanaged>
|
|
<unmanaged-short>MF_OPM_CGMSA_COPY_ONE_GENERATION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmCgmsaProtectionLevel.CopyNever">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_CGMSA_COPY_NEVER']/*"/>
|
|
<unmanaged>MF_OPM_CGMSA_COPY_NEVER</unmanaged>
|
|
<unmanaged-short>MF_OPM_CGMSA_COPY_NEVER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.OpmCgmsaProtectionLevel.RedistributionControlRequired">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPM_CGMSA_REDISTRIBUTION_CONTROL_REQUIRED']/*"/>
|
|
<unmanaged>MF_OPM_CGMSA_REDISTRIBUTION_CONTROL_REQUIRED</unmanaged>
|
|
<unmanaged-short>MF_OPM_CGMSA_REDISTRIBUTION_CONTROL_REQUIRED</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PEventType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Defines event types for the <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayerCallback"/></strong> interface.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>For each event type, the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> callback receives a reference to a data structure. The first part of the data structure is always an <strong><see cref="T:SharpDX.MediaFoundation.PEventHeader"/></strong> structure. The following table lists the data structure for each event type.</p><p>In your implementation of <strong>OnMediaPlayerEvent</strong>, you must cast the <em>pEventHeader</em> parameter to the correct structure type. A set of macros is defined for this purpose. These macros check the value of the event type and return <strong><c>null</c></strong> if there is a mismatch; otherwise they return a reference to the correct structure type.</p><table> <tr><th>Event type</th><th>Event structure</th><th>Pointer cast macro</th></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.Play"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PPlayEvent"/></strong> </td><td> <strong>MFP_GET_PLAY_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.Pause"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PPauseEvent"/></strong> </td><td> <strong>MFP_GET_PAUSE_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.Stop"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PStopEvent"/></strong> </td><td> <strong>MFP_GET_STOP_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.PositionSet"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PPositionSetEvent"/></strong> </td><td> <strong>MFP_GET_POSITION_SET_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.RateSet"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PRateSetEvent"/></strong> </td><td> <strong>MFP_GET_RATE_SET_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemCreated"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PMediaitemCreatedEvent"/></strong> </td><td> <strong>MFP_GET_MEDIAITEM_CREATED_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemSet"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PMediaitemSetEvent"/></strong> </td><td> <strong>MFP_GET_MEDIAITEM_SET_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.FrameStep"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PFrameStepEvent"/></strong> </td><td> <strong>MFP_GET_FRAME_STEP_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemCleared"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PMediaitemClearedEvent"/></strong> </td><td> <strong>MFP_GET_MEDIAITEM_CLEARED_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.Mf"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PMfEvent"/></strong> </td><td> <strong>MFP_GET_MF_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.Error"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PErrorEvent"/></strong> </td><td> <strong>MFP_GET_ERROR_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.PlaybackEnded"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PPlaybackEndedEvent"/></strong> </td><td> <strong>MFP_GET_PLAYBACK_ENDED_EVENT</strong> </td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.PEventType.AcquireUserCredential"/></td><td> <strong><see cref="T:SharpDX.MediaFoundation.PAcquireUserCredentialEvent"/></strong> </td><td> <strong>MFP_GET_ACQUIRE_USER_CREDENTIAL_EVENT</strong> </td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE']/*"/>
|
|
<msdn-id>dd375532</msdn-id>
|
|
<unmanaged>MFP_EVENT_TYPE</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.Play">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_PLAY']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_PLAY</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_PLAY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.Pause">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_PAUSE']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_PAUSE</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_PAUSE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.Stop">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_STOP']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_STOP</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_STOP</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.PositionSet">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_POSITION_SET']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_POSITION_SET</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_POSITION_SET</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.RateSet">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_RATE_SET']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_RATE_SET</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_RATE_SET</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.MediaitemCreated">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_MEDIAITEM_CREATED']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_MEDIAITEM_CREATED</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_MEDIAITEM_CREATED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.MediaitemSet">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_MEDIAITEM_SET']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_MEDIAITEM_SET</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_MEDIAITEM_SET</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.FrameStep">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_FRAME_STEP']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_FRAME_STEP</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_FRAME_STEP</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.MediaitemCleared">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_MEDIAITEM_CLEARED']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_MEDIAITEM_CLEARED</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_MEDIAITEM_CLEARED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.Mf">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_MF']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_MF</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_MF</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.Error">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_ERROR']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_ERROR</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_ERROR</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.PlaybackEnded">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_PLAYBACK_ENDED']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_PLAYBACK_ENDED</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_PLAYBACK_ENDED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventType.AcquireUserCredential">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_TYPE_ACQUIRE_USER_CREDENTIAL']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE_ACQUIRE_USER_CREDENTIAL</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE_ACQUIRE_USER_CREDENTIAL</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PluginControlPolicy">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Defines policy settings for the <strong><see cref="M:SharpDX.MediaFoundation.PluginControl2.SetPolicy(SharpDX.MediaFoundation.PluginControlPolicy)"/></strong> method.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_PLUGIN_CONTROL_POLICY']/*"/>
|
|
<msdn-id>hh162881</msdn-id>
|
|
<unmanaged>MF_PLUGIN_CONTROL_POLICY</unmanaged>
|
|
<unmanaged-short>MF_PLUGIN_CONTROL_POLICY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PluginControlPolicy.UseAllPlugins">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_PLUGIN_CONTROL_POLICY_USE_ALL_PLUGINS']/*"/>
|
|
<unmanaged>MF_PLUGIN_CONTROL_POLICY_USE_ALL_PLUGINS</unmanaged>
|
|
<unmanaged-short>MF_PLUGIN_CONTROL_POLICY_USE_ALL_PLUGINS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PluginControlPolicy.UseApprovedPlugins">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_PLUGIN_CONTROL_POLICY_USE_APPROVED_PLUGINS']/*"/>
|
|
<unmanaged>MF_PLUGIN_CONTROL_POLICY_USE_APPROVED_PLUGINS</unmanaged>
|
|
<unmanaged-short>MF_PLUGIN_CONTROL_POLICY_USE_APPROVED_PLUGINS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PluginControlPolicy.UseWebPlugins">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_PLUGIN_CONTROL_POLICY_USE_WEB_PLUGINS']/*"/>
|
|
<unmanaged>MF_PLUGIN_CONTROL_POLICY_USE_WEB_PLUGINS</unmanaged>
|
|
<unmanaged-short>MF_PLUGIN_CONTROL_POLICY_USE_WEB_PLUGINS</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PluginType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Adds a class identifier (CLSID) to the preferred list or removes a CLSID from the list.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The preferred list is global to the caller's process. Calling this method does not affect the list in other process.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_Plugin_Type']/*"/>
|
|
<msdn-id>dd374308</msdn-id>
|
|
<unmanaged>MF_Plugin_Type</unmanaged>
|
|
<unmanaged-short>MF_Plugin_Type</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PluginType.Mft">
|
|
<summary>
|
|
<dd> <p>Member of the <strong><see cref="T:SharpDX.MediaFoundation.PluginType"/></strong> enumeration, specifying the type of object.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_Plugin_Type_MFT']/*"/>
|
|
<msdn-id>dd374308</msdn-id>
|
|
<unmanaged>MF_Plugin_Type_MFT</unmanaged>
|
|
<unmanaged-short>MF_Plugin_Type_MFT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PluginType.MediaSource">
|
|
<summary>
|
|
<dd> <p>The key name for the CLSID. For more information about the format of key names, see the Remarks section of <strong><see cref="T:SharpDX.MediaFoundation.PluginControl"/></strong>.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_Plugin_Type_MediaSource']/*"/>
|
|
<msdn-id>dd374308</msdn-id>
|
|
<unmanaged>MF_Plugin_Type_MediaSource</unmanaged>
|
|
<unmanaged-short>MF_Plugin_Type_MediaSource</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PluginType.MftMatchOutputType">
|
|
<summary>
|
|
<dd> <p>The CLSID to add to the list. If this parameter is <strong><c>null</c></strong>, the key/value entry specified by the <em>selector</em> parameter is removed from the list. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_Plugin_Type_MFT_MatchOutputType']/*"/>
|
|
<msdn-id>dd374308</msdn-id>
|
|
<unmanaged>MF_Plugin_Type_MFT_MatchOutputType</unmanaged>
|
|
<unmanaged-short>MF_Plugin_Type_MFT_MatchOutputType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PluginType.Other">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_Plugin_Type_Other']/*"/>
|
|
<unmanaged>MF_Plugin_Type_Other</unmanaged>
|
|
<unmanaged-short>MF_Plugin_Type_Other</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMediaplayerState">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Specifies the current playback state.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAPLAYER_STATE']/*"/>
|
|
<msdn-id>dd375562</msdn-id>
|
|
<unmanaged>MFP_MEDIAPLAYER_STATE</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAPLAYER_STATE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaplayerState.Empty">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAPLAYER_STATE_EMPTY']/*"/>
|
|
<unmanaged>MFP_MEDIAPLAYER_STATE_EMPTY</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAPLAYER_STATE_EMPTY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaplayerState.Stopped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAPLAYER_STATE_STOPPED']/*"/>
|
|
<unmanaged>MFP_MEDIAPLAYER_STATE_STOPPED</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAPLAYER_STATE_STOPPED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaplayerState.Playing">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAPLAYER_STATE_PLAYING']/*"/>
|
|
<unmanaged>MFP_MEDIAPLAYER_STATE_PLAYING</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAPLAYER_STATE_PLAYING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaplayerState.Paused">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAPLAYER_STATE_PAUSED']/*"/>
|
|
<unmanaged>MFP_MEDIAPLAYER_STATE_PAUSED</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAPLAYER_STATE_PAUSED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaplayerState.Shutdown">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAPLAYER_STATE_SHUTDOWN']/*"/>
|
|
<unmanaged>MFP_MEDIAPLAYER_STATE_SHUTDOWN</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAPLAYER_STATE_SHUTDOWN</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PmpsessionCreationFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Contains flags that define the behavior of the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong> function. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPMPSESSION_CREATION_FLAGS']/*"/>
|
|
<msdn-id>ms697495</msdn-id>
|
|
<unmanaged>MFPMPSESSION_CREATION_FLAGS</unmanaged>
|
|
<unmanaged-short>MFPMPSESSION_CREATION_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PmpsessionCreationFlags.UnprotectedProcess">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPMPSESSION_UNPROTECTED_PROCESS']/*"/>
|
|
<unmanaged>MFPMPSESSION_UNPROTECTED_PROCESS</unmanaged>
|
|
<unmanaged-short>MFPMPSESSION_UNPROTECTED_PROCESS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PmpsessionCreationFlags.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.MediaFoundation.PolicymanagerAction">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Defines actions that can be performed on a stream.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPOLICYMANAGER_ACTION']/*"/>
|
|
<msdn-id>ms698977</msdn-id>
|
|
<unmanaged>MFPOLICYMANAGER_ACTION</unmanaged>
|
|
<unmanaged-short>MFPOLICYMANAGER_ACTION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PolicymanagerAction.PeactionNo">
|
|
<summary>
|
|
<dd> <p>No action.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='PEACTION_NO']/*"/>
|
|
<msdn-id>ms698977</msdn-id>
|
|
<unmanaged>PEACTION_NO</unmanaged>
|
|
<unmanaged-short>PEACTION_NO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PolicymanagerAction.PeactionPlay">
|
|
<summary>
|
|
<dd> <p>Play the stream.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='PEACTION_PLAY']/*"/>
|
|
<msdn-id>ms698977</msdn-id>
|
|
<unmanaged>PEACTION_PLAY</unmanaged>
|
|
<unmanaged-short>PEACTION_PLAY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PolicymanagerAction.PeactionCopy">
|
|
<summary>
|
|
<dd> <p>Copy the stream.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='PEACTION_COPY']/*"/>
|
|
<msdn-id>ms698977</msdn-id>
|
|
<unmanaged>PEACTION_COPY</unmanaged>
|
|
<unmanaged-short>PEACTION_COPY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PolicymanagerAction.PeactionExport">
|
|
<summary>
|
|
<dd> <p>Export the stream to another format.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='PEACTION_EXPORT']/*"/>
|
|
<msdn-id>ms698977</msdn-id>
|
|
<unmanaged>PEACTION_EXPORT</unmanaged>
|
|
<unmanaged-short>PEACTION_EXPORT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PolicymanagerAction.PeactionExtract">
|
|
<summary>
|
|
<dd> <p>Extract the data from the stream and pass it to the application. For example, acoustic echo cancellation requires this action.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='PEACTION_EXTRACT']/*"/>
|
|
<msdn-id>ms698977</msdn-id>
|
|
<unmanaged>PEACTION_EXTRACT</unmanaged>
|
|
<unmanaged-short>PEACTION_EXTRACT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PolicymanagerAction.PeactionReserved1">
|
|
<summary>
|
|
<dd> <p>Reserved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='PEACTION_RESERVED1']/*"/>
|
|
<msdn-id>ms698977</msdn-id>
|
|
<unmanaged>PEACTION_RESERVED1</unmanaged>
|
|
<unmanaged-short>PEACTION_RESERVED1</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PolicymanagerAction.PeactionReserved2">
|
|
<summary>
|
|
<dd> <p>Reserved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='PEACTION_RESERVED2']/*"/>
|
|
<msdn-id>ms698977</msdn-id>
|
|
<unmanaged>PEACTION_RESERVED2</unmanaged>
|
|
<unmanaged-short>PEACTION_RESERVED2</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PolicymanagerAction.PeactionReserved3">
|
|
<summary>
|
|
<dd> <p>Reserved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='PEACTION_RESERVED3']/*"/>
|
|
<msdn-id>ms698977</msdn-id>
|
|
<unmanaged>PEACTION_RESERVED3</unmanaged>
|
|
<unmanaged-short>PEACTION_RESERVED3</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PolicymanagerAction.PeactionLast">
|
|
<summary>
|
|
<dd> <p>Last member of the enumeration.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='PEACTION_LAST']/*"/>
|
|
<msdn-id>ms698977</msdn-id>
|
|
<unmanaged>PEACTION_LAST</unmanaged>
|
|
<unmanaged-short>PEACTION_LAST</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.QualityAdviseFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains flags for the <strong><see cref="M:SharpDX.MediaFoundation.QualityAdvise2.NotifyQualityEvent(SharpDX.MediaFoundation.MediaEvent,System.Int32@)"/></strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the decoder sets the <strong><see cref="F:SharpDX.MediaFoundation.QualityAdviseFlags.CannotKeepUp"/></strong> flag, the quality manager tries to reduce latency through the media source and the media sink. For example, it might request the Enhanced Video Renderer (EVR) to drop frames. During this period, the quality manager stops calling the decoder's <strong><see cref="M:SharpDX.MediaFoundation.QualityAdvise2.NotifyQualityEvent(SharpDX.MediaFoundation.MediaEvent,System.Int32@)"/></strong> method, until samples are no longer arriving late at the sink. At that point, the quality manager resumes calling <strong>NotifyQualityEvent</strong> on the decoder.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_QUALITY_ADVISE_FLAGS']/*"/>
|
|
<msdn-id>dd743824</msdn-id>
|
|
<unmanaged>MF_QUALITY_ADVISE_FLAGS</unmanaged>
|
|
<unmanaged-short>MF_QUALITY_ADVISE_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityAdviseFlags.CannotKeepUp">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_QUALITY_CANNOT_KEEP_UP']/*"/>
|
|
<unmanaged>MF_QUALITY_CANNOT_KEEP_UP</unmanaged>
|
|
<unmanaged-short>MF_QUALITY_CANNOT_KEEP_UP</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityAdviseFlags.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.MediaFoundation.QualityDropMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Specifies how aggressively a pipeline component should drop samples.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>In drop mode, a component drops samples, more or less aggressively depending on the level of the drop mode. The specific algorithm used depends on the component. Mode 1 is the least aggressive mode, and mode 5 is the most aggressive. A component is not required to implement all five levels.</p><p>For example, suppose an encoded video stream has three B-frames between each pair of P-frames. A decoder might implement the following drop modes:</p><ul> <li> <p>Mode 1: Drop one out of every three B frames.</p> </li> <li> <p>Mode 2: Drop one out of every two B frames.</p> </li> <li> <p>Mode 3: Drop all delta frames.</p> </li> <li> <p>Modes 4 and 5: Unsupported.</p> </li> </ul><p>The enhanced video renderer (EVR) can drop video frames before sending them to the EVR mixer.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_QUALITY_DROP_MODE']/*"/>
|
|
<msdn-id>ms704659</msdn-id>
|
|
<unmanaged>MF_QUALITY_DROP_MODE</unmanaged>
|
|
<unmanaged-short>MF_QUALITY_DROP_MODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityDropMode.MfDropModeNone">
|
|
<summary>
|
|
<dd> <p>Normal processing of samples. Drop mode is disabled.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_DROP_MODE_NONE']/*"/>
|
|
<msdn-id>ms704659</msdn-id>
|
|
<unmanaged>MF_DROP_MODE_NONE</unmanaged>
|
|
<unmanaged-short>MF_DROP_MODE_NONE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityDropMode.MfDropMode1">
|
|
<summary>
|
|
<dd> <p>First drop mode (least aggressive).</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_DROP_MODE_1']/*"/>
|
|
<msdn-id>ms704659</msdn-id>
|
|
<unmanaged>MF_DROP_MODE_1</unmanaged>
|
|
<unmanaged-short>MF_DROP_MODE_1</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityDropMode.MfDropMode2">
|
|
<summary>
|
|
<dd> <p>Second drop mode.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_DROP_MODE_2']/*"/>
|
|
<msdn-id>ms704659</msdn-id>
|
|
<unmanaged>MF_DROP_MODE_2</unmanaged>
|
|
<unmanaged-short>MF_DROP_MODE_2</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityDropMode.MfDropMode3">
|
|
<summary>
|
|
<dd> <p>Third drop mode.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_DROP_MODE_3']/*"/>
|
|
<msdn-id>ms704659</msdn-id>
|
|
<unmanaged>MF_DROP_MODE_3</unmanaged>
|
|
<unmanaged-short>MF_DROP_MODE_3</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityDropMode.MfDropMode4">
|
|
<summary>
|
|
<dd> <p>Fourth drop mode.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_DROP_MODE_4']/*"/>
|
|
<msdn-id>ms704659</msdn-id>
|
|
<unmanaged>MF_DROP_MODE_4</unmanaged>
|
|
<unmanaged-short>MF_DROP_MODE_4</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityDropMode.MfDropMode5">
|
|
<summary>
|
|
<dd> <p>Fifth drop mode (most aggressive, if it is supported; see Remarks).</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_DROP_MODE_5']/*"/>
|
|
<msdn-id>ms704659</msdn-id>
|
|
<unmanaged>MF_DROP_MODE_5</unmanaged>
|
|
<unmanaged-short>MF_DROP_MODE_5</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityDropMode.MfNumDropModes">
|
|
<summary>
|
|
<dd> <p>Maximum number of drop modes. This value is not a valid flag.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_NUM_DROP_MODES']/*"/>
|
|
<msdn-id>ms704659</msdn-id>
|
|
<unmanaged>MF_NUM_DROP_MODES</unmanaged>
|
|
<unmanaged-short>MF_NUM_DROP_MODES</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.QualityLevel">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Specifies the quality level for a pipeline component. The quality level determines how the component consumes or produces samples.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> Each successive quality level decreases the amount of processing that is needed, while also reducing the resulting quality of the audio or video. The specific algorithm used to reduce quality depends on the component. Mode 1 is the least aggressive mode, and mode 5 is the most aggressive. A component is not required to implement all five levels. Also, the same quality level might not be comparable between two different components. </p><p> Video decoders can often reduce quality by leaving out certain post-processing steps. The enhanced video renderer (EVR) can sometimes reduce quality by switching to a different deinterlacing mode. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_QUALITY_LEVEL']/*"/>
|
|
<msdn-id>ms698949</msdn-id>
|
|
<unmanaged>MF_QUALITY_LEVEL</unmanaged>
|
|
<unmanaged-short>MF_QUALITY_LEVEL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityLevel.MfQualityNormal">
|
|
<summary>
|
|
<dd> <p> Normal quality. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_QUALITY_NORMAL']/*"/>
|
|
<msdn-id>ms698949</msdn-id>
|
|
<unmanaged>MF_QUALITY_NORMAL</unmanaged>
|
|
<unmanaged-short>MF_QUALITY_NORMAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityLevel.MfQualityNormalMinus1">
|
|
<summary>
|
|
<dd> <p> One level below normal quality. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_QUALITY_NORMAL_MINUS_1']/*"/>
|
|
<msdn-id>ms698949</msdn-id>
|
|
<unmanaged>MF_QUALITY_NORMAL_MINUS_1</unmanaged>
|
|
<unmanaged-short>MF_QUALITY_NORMAL_MINUS_1</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityLevel.MfQualityNormalMinus2">
|
|
<summary>
|
|
<dd> <p> Two levels below normal quality. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_QUALITY_NORMAL_MINUS_2']/*"/>
|
|
<msdn-id>ms698949</msdn-id>
|
|
<unmanaged>MF_QUALITY_NORMAL_MINUS_2</unmanaged>
|
|
<unmanaged-short>MF_QUALITY_NORMAL_MINUS_2</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityLevel.MfQualityNormalMinus3">
|
|
<summary>
|
|
<dd> <p> Three levels below normal quality. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_QUALITY_NORMAL_MINUS_3']/*"/>
|
|
<msdn-id>ms698949</msdn-id>
|
|
<unmanaged>MF_QUALITY_NORMAL_MINUS_3</unmanaged>
|
|
<unmanaged-short>MF_QUALITY_NORMAL_MINUS_3</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityLevel.MfQualityNormalMinus4">
|
|
<summary>
|
|
<dd> <p> Four levels below normal quality. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_QUALITY_NORMAL_MINUS_4']/*"/>
|
|
<msdn-id>ms698949</msdn-id>
|
|
<unmanaged>MF_QUALITY_NORMAL_MINUS_4</unmanaged>
|
|
<unmanaged-short>MF_QUALITY_NORMAL_MINUS_4</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityLevel.MfQualityNormalMinus5">
|
|
<summary>
|
|
<dd> <p> Five levels below normal quality. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_QUALITY_NORMAL_MINUS_5']/*"/>
|
|
<msdn-id>ms698949</msdn-id>
|
|
<unmanaged>MF_QUALITY_NORMAL_MINUS_5</unmanaged>
|
|
<unmanaged-short>MF_QUALITY_NORMAL_MINUS_5</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.QualityLevel.MfNumQualityLevels">
|
|
<summary>
|
|
<dd> <p> Maximum number of quality levels. This value is not a valid flag. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_NUM_QUALITY_LEVELS']/*"/>
|
|
<msdn-id>ms698949</msdn-id>
|
|
<unmanaged>MF_NUM_QUALITY_LEVELS</unmanaged>
|
|
<unmanaged-short>MF_NUM_QUALITY_LEVELS</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.RateDirection">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRATE_DIRECTION']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFRATE_DIRECTION</unmanaged>
|
|
<unmanaged-short>MFRATE_DIRECTION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.RateDirection.Forward">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRATE_FORWARD']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFRATE_FORWARD</unmanaged>
|
|
<unmanaged-short>MFRATE_FORWARD</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.RateDirection.Reverse">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRATE_REVERSE']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFRATE_REVERSE</unmanaged>
|
|
<unmanaged-short>MFRATE_REVERSE</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SampleProtectionVersion">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the sample protection certificate.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>For certain version numbers of sample protection, the downstream component must provide a certificate. Components that do not support these version numbers can return E_NOTIMPL.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SAMPLE_PROTECTION_VERSION']/*"/>
|
|
<msdn-id>bb970503</msdn-id>
|
|
<unmanaged>SAMPLE_PROTECTION_VERSION</unmanaged>
|
|
<unmanaged-short>SAMPLE_PROTECTION_VERSION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleProtectionVersion.No">
|
|
<summary>
|
|
<dd> <p>Specifies the version number of the sample protection scheme for which to receive a certificate. The version number is specified as a <strong><see cref="T:SharpDX.MediaFoundation.SampleProtectionVersion"/></strong> enumeration value.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SAMPLE_PROTECTION_VERSION_NO']/*"/>
|
|
<msdn-id>bb970503</msdn-id>
|
|
<unmanaged>SAMPLE_PROTECTION_VERSION_NO</unmanaged>
|
|
<unmanaged-short>SAMPLE_PROTECTION_VERSION_NO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleProtectionVersion.BasicLoki">
|
|
<summary>
|
|
<dd> <p>Receives a reference to a buffer containing the certificate. The caller must free the memory for the buffer by calling <strong>CoTaskMemFree</strong>.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SAMPLE_PROTECTION_VERSION_BASIC_LOKI']/*"/>
|
|
<msdn-id>bb970503</msdn-id>
|
|
<unmanaged>SAMPLE_PROTECTION_VERSION_BASIC_LOKI</unmanaged>
|
|
<unmanaged-short>SAMPLE_PROTECTION_VERSION_BASIC_LOKI</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleProtectionVersion.Scatter">
|
|
<summary>
|
|
<dd> <p>Receives the size of the <em>ppCert</em> buffer, in bytes.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SAMPLE_PROTECTION_VERSION_SCATTER']/*"/>
|
|
<msdn-id>bb970503</msdn-id>
|
|
<unmanaged>SAMPLE_PROTECTION_VERSION_SCATTER</unmanaged>
|
|
<unmanaged-short>SAMPLE_PROTECTION_VERSION_SCATTER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleProtectionVersion.Rc4">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SAMPLE_PROTECTION_VERSION_RC4']/*"/>
|
|
<unmanaged>SAMPLE_PROTECTION_VERSION_RC4</unmanaged>
|
|
<unmanaged-short>SAMPLE_PROTECTION_VERSION_RC4</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SequencerTopologyFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSequencerTopologyFlags']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFSequencerTopologyFlags</unmanaged>
|
|
<unmanaged-short>MFSequencerTopologyFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SequencerTopologyFlags.SequencerTopologyFlagsLast">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SequencerTopologyFlags_Last']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>SequencerTopologyFlags_Last</unmanaged>
|
|
<unmanaged-short>SequencerTopologyFlags_Last</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ServiceLookupType">
|
|
<summary>
|
|
<p>Retrieves an interface from the enhanced video renderer (EVR), or from the video mixer or video presenter.</p> <see cref="T:SharpDX.Result"/> LookupService( <see cref="T:SharpDX.MediaFoundation.ServiceLookupType"/> Type, DWORD dwIndex, REFGUID guidService, REFIID riid, LPVOID* ppvObjects, DWORD* pnObjects
|
|
);
|
|
<p></p>Parameters <p> Type </p> <p>[in] Specifies the scope of the search. Currently this parameter is ignored. Use the value <see cref="F:SharpDX.MediaFoundation.ServiceLookupType.Global"/>.</p> <p> dwIndex </p> <p>[in] Reserved, must be zero.</p> <p> guidService </p> <p>[in] Service <see cref="T:System.Guid"/> of the requested interface.</p> <p> riid </p> <p>[in] Interface identifier of the requested interface.</p> <p> ppvObjects </p> <p>[out] Array of interface references. If the method succeeds, each member of the array is initialized to the requested interface. The caller must release the interface references when the EVR calls <see cref="M:SharpDX.MediaFoundation.TopologyServiceLookupClient.ReleaseServicePointers"/>.</p> <p> pnObjects </p> <p>[in, out] On input, a reference to a value that specifies the size of the ppvObjects array. The value must be at least 1. On output, receives the number of valid references copied into the ppvObjects array. In the current implementation, there is no particular reason to specify an array size larger than one element.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>E_INVALIDARG</p> </td> <td> <p>Invalid argument. </p> </td> </tr><tr> <td> <p>E_NOINTERFACE</p> </td> <td> <p>The requested interface is not available.</p> </td> </tr><tr> <td> <p>MF_E_NOTACCEPTING</p> </td> <td> <p>The method was not called from inside the InitServicePointers method. See Remarks.</p> </td> </tr><tr> <td> <p>MF_E_UNSUPPORTED_SERVICE</p> </td> <td> <p>The object does not support the specified service <see cref="T:System.Guid"/>.</p> </td> </tr></table> <p>This method can be called only from inside the <see cref="M:SharpDX.MediaFoundation.TopologyServiceLookupClient.InitServicePointers(SharpDX.MediaFoundation.TopologyServiceLookup)"/> method. At any other time, the method returns MF_E_NOTACCEPTING.</p> <p>The presenter can use this method to query the EVR and the mixer. The mixer can use it to query the EVR and the presenter. Which objects are queried depends on the caller and the service <see cref="T:System.Guid"/>, as shown in the following table. </p> <table><tr> <th> Caller </th> <th> Service <see cref="T:System.Guid"/> </th> <th> Objects queried </th> </tr><tr> <td> <p>Presenter</p> </td> <td> <p>MR_VIDEO_RENDER_SERVICE</p> </td> <td> <p>EVR</p> </td> </tr><tr> <td> <p>Presenter</p> </td> <td> <p>MR_VIDEO_MIXER_SERVICE</p> </td> <td> <p>Mixer</p> </td> </tr><tr> <td> <p>Mixer</p> </td> <td> <p>MR_VIDEO_RENDER_SERVICE</p> </td> <td> <p>Presenter and EVR</p> </td> </tr></table> <p>The following interfaces are available from the EVR:</p> <ul><li> <p> IMediaEventSink Interface</p> </li><li> <p> <see cref="T:SharpDX.MediaFoundation.Clock"/> Interface </p> </li><li> <p> <see cref="T:SharpDX.MediaFoundation.Timer"/> Interface </p> </li><li> <p> <see cref="T:SharpDX.MediaFoundation.PresentationClock"/> Interface </p> </li></ul> <p>The IMediaEventSink interface is documented in the DirectShow SDK documentation.</p> <p>The following interfaces are available from the mixer:</p> <ul><li> <p> <see cref="T:SharpDX.MediaFoundation.Transform"/> Interface </p> </li><li> <p> <see cref="T:SharpDX.MediaFoundation.VideoDeviceID"/> Interface </p> </li></ul> <p> Client: Requires Windows Vista.</p> <p> Header: Include evr.h.</p> <p> Library: Use strmiids.lib.</p> ReferenceIMFTopologyServiceLookup InterfaceConceptsHow to Write an EVR Presenter
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SERVICE_LOOKUP_TYPE']/*"/>
|
|
<msdn-id>ms702184</msdn-id>
|
|
<unmanaged>MF_SERVICE_LOOKUP_TYPE</unmanaged>
|
|
<unmanaged-short>MF_SERVICE_LOOKUP_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ServiceLookupType.Upstream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SERVICE_LOOKUP_UPSTREAM']/*"/>
|
|
<unmanaged>MF_SERVICE_LOOKUP_UPSTREAM</unmanaged>
|
|
<unmanaged-short>MF_SERVICE_LOOKUP_UPSTREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ServiceLookupType.UpstreamDirect">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SERVICE_LOOKUP_UPSTREAM_DIRECT']/*"/>
|
|
<unmanaged>MF_SERVICE_LOOKUP_UPSTREAM_DIRECT</unmanaged>
|
|
<unmanaged-short>MF_SERVICE_LOOKUP_UPSTREAM_DIRECT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ServiceLookupType.Downstream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SERVICE_LOOKUP_DOWNSTREAM']/*"/>
|
|
<unmanaged>MF_SERVICE_LOOKUP_DOWNSTREAM</unmanaged>
|
|
<unmanaged-short>MF_SERVICE_LOOKUP_DOWNSTREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ServiceLookupType.DownstreamDirect">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SERVICE_LOOKUP_DOWNSTREAM_DIRECT']/*"/>
|
|
<unmanaged>MF_SERVICE_LOOKUP_DOWNSTREAM_DIRECT</unmanaged>
|
|
<unmanaged-short>MF_SERVICE_LOOKUP_DOWNSTREAM_DIRECT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ServiceLookupType.All">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SERVICE_LOOKUP_ALL']/*"/>
|
|
<unmanaged>MF_SERVICE_LOOKUP_ALL</unmanaged>
|
|
<unmanaged-short>MF_SERVICE_LOOKUP_ALL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ServiceLookupType.Global">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SERVICE_LOOKUP_GLOBAL']/*"/>
|
|
<unmanaged>MF_SERVICE_LOOKUP_GLOBAL</unmanaged>
|
|
<unmanaged-short>MF_SERVICE_LOOKUP_GLOBAL</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SessionGetfulltopologyFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSESSION_GETFULLTOPOLOGY_FLAGS']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFSESSION_GETFULLTOPOLOGY_FLAGS</unmanaged>
|
|
<unmanaged-short>MFSESSION_GETFULLTOPOLOGY_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SessionGetfulltopologyFlags.Current">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSESSION_GETFULLTOPOLOGY_CURRENT']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFSESSION_GETFULLTOPOLOGY_CURRENT</unmanaged>
|
|
<unmanaged-short>MFSESSION_GETFULLTOPOLOGY_CURRENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SessionGetfulltopologyFlags.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.MediaFoundation.SessionSettopologyFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines the behavior of the <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.SetTopology(System.Int32,SharpDX.MediaFoundation.Topology)"/></strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> These flags are optional, and are not mutually exclusive. If no flags are set, the Media Session resolves the topology and then adds it to the queue of pending presentations. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSESSION_SETTOPOLOGY_FLAGS']/*"/>
|
|
<msdn-id>ms696169</msdn-id>
|
|
<unmanaged>MFSESSION_SETTOPOLOGY_FLAGS</unmanaged>
|
|
<unmanaged-short>MFSESSION_SETTOPOLOGY_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SessionSettopologyFlags.Immediate">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSESSION_SETTOPOLOGY_IMMEDIATE']/*"/>
|
|
<unmanaged>MFSESSION_SETTOPOLOGY_IMMEDIATE</unmanaged>
|
|
<unmanaged-short>MFSESSION_SETTOPOLOGY_IMMEDIATE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SessionSettopologyFlags.Noresolution">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSESSION_SETTOPOLOGY_NORESOLUTION']/*"/>
|
|
<unmanaged>MFSESSION_SETTOPOLOGY_NORESOLUTION</unmanaged>
|
|
<unmanaged-short>MFSESSION_SETTOPOLOGY_NORESOLUTION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SessionSettopologyFlags.ClearCurrent">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSESSION_SETTOPOLOGY_CLEAR_CURRENT']/*"/>
|
|
<unmanaged>MFSESSION_SETTOPOLOGY_CLEAR_CURRENT</unmanaged>
|
|
<unmanaged-short>MFSESSION_SETTOPOLOGY_CLEAR_CURRENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SessionSettopologyFlags.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.MediaFoundation.ShutdownStatus">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Describes the current status of a call to the <strong><see cref="M:SharpDX.MediaFoundation.Shutdownable.Shutdown"/></strong> method.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSHUTDOWN_STATUS']/*"/>
|
|
<msdn-id>ms701630</msdn-id>
|
|
<unmanaged>MFSHUTDOWN_STATUS</unmanaged>
|
|
<unmanaged-short>MFSHUTDOWN_STATUS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ShutdownStatus.Initiated">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSHUTDOWN_INITIATED']/*"/>
|
|
<unmanaged>MFSHUTDOWN_INITIATED</unmanaged>
|
|
<unmanaged-short>MFSHUTDOWN_INITIATED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ShutdownStatus.Completed">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSHUTDOWN_COMPLETED']/*"/>
|
|
<unmanaged>MFSHUTDOWN_COMPLETED</unmanaged>
|
|
<unmanaged-short>MFSHUTDOWN_COMPLETED</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SinkWmdrmaction">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSINK_WMDRMACTION']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFSINK_WMDRMACTION</unmanaged>
|
|
<unmanaged-short>MFSINK_WMDRMACTION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWmdrmaction.Undefined">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSINK_WMDRMACTION_UNDEFINED']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFSINK_WMDRMACTION_UNDEFINED</unmanaged>
|
|
<unmanaged-short>MFSINK_WMDRMACTION_UNDEFINED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWmdrmaction.Encode">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSINK_WMDRMACTION_ENCODE']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFSINK_WMDRMACTION_ENCODE</unmanaged>
|
|
<unmanaged-short>MFSINK_WMDRMACTION_ENCODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWmdrmaction.Transcode">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSINK_WMDRMACTION_TRANSCODE']/*"/>
|
|
<unmanaged>MFSINK_WMDRMACTION_TRANSCODE</unmanaged>
|
|
<unmanaged-short>MFSINK_WMDRMACTION_TRANSCODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWmdrmaction.Transcrypt">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSINK_WMDRMACTION_TRANSCRYPT']/*"/>
|
|
<unmanaged>MFSINK_WMDRMACTION_TRANSCRYPT</unmanaged>
|
|
<unmanaged-short>MFSINK_WMDRMACTION_TRANSCRYPT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWmdrmaction.Last">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSINK_WMDRMACTION_LAST']/*"/>
|
|
<unmanaged>MFSINK_WMDRMACTION_LAST</unmanaged>
|
|
<unmanaged-short>MFSINK_WMDRMACTION_LAST</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SinkWriterIndex">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='__MIDL___MIDL_itf_mfreadwrite_0000_0004_0001']/*"/>
|
|
<unmanaged>__MIDL___MIDL_itf_mfreadwrite_0000_0004_0001</unmanaged>
|
|
<unmanaged-short>__MIDL___MIDL_itf_mfreadwrite_0000_0004_0001</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterIndex.InvalidStreamIndex">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_INVALID_STREAM_INDEX']/*"/>
|
|
<unmanaged>MF_SINK_WRITER_INVALID_STREAM_INDEX</unmanaged>
|
|
<unmanaged-short>MF_SINK_WRITER_INVALID_STREAM_INDEX</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterIndex.AllStreams">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_ALL_STREAMS']/*"/>
|
|
<unmanaged>MF_SINK_WRITER_ALL_STREAMS</unmanaged>
|
|
<unmanaged-short>MF_SINK_WRITER_ALL_STREAMS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterIndex.Mediasink">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_MEDIASINK']/*"/>
|
|
<unmanaged>MF_SINK_WRITER_MEDIASINK</unmanaged>
|
|
<unmanaged-short>MF_SINK_WRITER_MEDIASINK</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SourceReaderControlFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains flags for the <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.ReadSample(System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int64@,SharpDX.MediaFoundation.Sample@)"/></strong> method.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READER_CONTROL_FLAG']/*"/>
|
|
<msdn-id>dd375771</msdn-id>
|
|
<unmanaged>MF_SOURCE_READER_CONTROL_FLAG</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READER_CONTROL_FLAG</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderControlFlags.ControlfDrain">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READER_CONTROLF_DRAIN']/*"/>
|
|
<unmanaged>MF_SOURCE_READER_CONTROLF_DRAIN</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READER_CONTROLF_DRAIN</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderControlFlags.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.MediaFoundation.SourceReaderFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains flags that indicate the status of the <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.ReadSample(System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int64@,SharpDX.MediaFoundation.Sample@)"/></strong> method.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READER_FLAG']/*"/>
|
|
<msdn-id>dd375773</msdn-id>
|
|
<unmanaged>MF_SOURCE_READER_FLAG</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READER_FLAG</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderFlags.FError">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READERF_ERROR']/*"/>
|
|
<unmanaged>MF_SOURCE_READERF_ERROR</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READERF_ERROR</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderFlags.FEndofstream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READERF_ENDOFSTREAM']/*"/>
|
|
<unmanaged>MF_SOURCE_READERF_ENDOFSTREAM</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READERF_ENDOFSTREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderFlags.FNewstream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READERF_NEWSTREAM']/*"/>
|
|
<unmanaged>MF_SOURCE_READERF_NEWSTREAM</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READERF_NEWSTREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderFlags.FNativemediatypechanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READERF_NATIVEMEDIATYPECHANGED']/*"/>
|
|
<unmanaged>MF_SOURCE_READERF_NATIVEMEDIATYPECHANGED</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READERF_NATIVEMEDIATYPECHANGED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderFlags.FCurrentmediatypechanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READERF_CURRENTMEDIATYPECHANGED']/*"/>
|
|
<unmanaged>MF_SOURCE_READERF_CURRENTMEDIATYPECHANGED</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READERF_CURRENTMEDIATYPECHANGED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderFlags.FStreamtick">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READERF_STREAMTICK']/*"/>
|
|
<unmanaged>MF_SOURCE_READERF_STREAMTICK</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READERF_STREAMTICK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderFlags.FAlleffectsremoved">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READERF_ALLEFFECTSREMOVED']/*"/>
|
|
<unmanaged>MF_SOURCE_READERF_ALLEFFECTSREMOVED</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READERF_ALLEFFECTSREMOVED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderFlags.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.MediaFoundation.SourceReaderIndex">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='__MIDL___MIDL_itf_mfreadwrite_0000_0001_0001']/*"/>
|
|
<unmanaged>__MIDL___MIDL_itf_mfreadwrite_0000_0001_0001</unmanaged>
|
|
<unmanaged-short>__MIDL___MIDL_itf_mfreadwrite_0000_0001_0001</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderIndex.InvalidStreamIndex">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READER_INVALID_STREAM_INDEX']/*"/>
|
|
<unmanaged>MF_SOURCE_READER_INVALID_STREAM_INDEX</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READER_INVALID_STREAM_INDEX</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderIndex.AllStreams">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READER_ALL_STREAMS']/*"/>
|
|
<unmanaged>MF_SOURCE_READER_ALL_STREAMS</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READER_ALL_STREAMS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderIndex.AnyStream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READER_ANY_STREAM']/*"/>
|
|
<unmanaged>MF_SOURCE_READER_ANY_STREAM</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READER_ANY_STREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READER_FIRST_AUDIO_STREAM']/*"/>
|
|
<unmanaged>MF_SOURCE_READER_FIRST_AUDIO_STREAM</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READER_FIRST_AUDIO_STREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READER_FIRST_VIDEO_STREAM']/*"/>
|
|
<unmanaged>MF_SOURCE_READER_FIRST_VIDEO_STREAM</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READER_FIRST_VIDEO_STREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderIndex.Mediasource">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SOURCE_READER_MEDIASOURCE']/*"/>
|
|
<unmanaged>MF_SOURCE_READER_MEDIASOURCE</unmanaged>
|
|
<unmanaged-short>MF_SOURCE_READER_MEDIASOURCE</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SourceResolverFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='__MIDL___MIDL_itf_mfidl_0000_0001_0001']/*"/>
|
|
<unmanaged>__MIDL___MIDL_itf_mfidl_0000_0001_0001</unmanaged>
|
|
<unmanaged-short>__MIDL___MIDL_itf_mfidl_0000_0001_0001</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_RESOLUTION_MEDIASOURCE']/*"/>
|
|
<unmanaged>MF_RESOLUTION_MEDIASOURCE</unmanaged>
|
|
<unmanaged-short>MF_RESOLUTION_MEDIASOURCE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_RESOLUTION_BYTESTREAM']/*"/>
|
|
<unmanaged>MF_RESOLUTION_BYTESTREAM</unmanaged>
|
|
<unmanaged-short>MF_RESOLUTION_BYTESTREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceResolverFlags.ContentDoesNotHaveToMatchExtensionOrMimeType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_RESOLUTION_CONTENT_DOES_NOT_HAVE_TO_MATCH_EXTENSION_OR_MIME_TYPE']/*"/>
|
|
<unmanaged>MF_RESOLUTION_CONTENT_DOES_NOT_HAVE_TO_MATCH_EXTENSION_OR_MIME_TYPE</unmanaged>
|
|
<unmanaged-short>MF_RESOLUTION_CONTENT_DOES_NOT_HAVE_TO_MATCH_EXTENSION_OR_MIME_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceResolverFlags.KeepByteStreamAliveOnFail">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_RESOLUTION_KEEP_BYTE_STREAM_ALIVE_ON_FAIL']/*"/>
|
|
<unmanaged>MF_RESOLUTION_KEEP_BYTE_STREAM_ALIVE_ON_FAIL</unmanaged>
|
|
<unmanaged-short>MF_RESOLUTION_KEEP_BYTE_STREAM_ALIVE_ON_FAIL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceResolverFlags.DisableLocalPlugins">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_RESOLUTION_DISABLE_LOCAL_PLUGINS']/*"/>
|
|
<unmanaged>MF_RESOLUTION_DISABLE_LOCAL_PLUGINS</unmanaged>
|
|
<unmanaged-short>MF_RESOLUTION_DISABLE_LOCAL_PLUGINS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceResolverFlags.PluginControlPolicyApprovedOnly">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_RESOLUTION_PLUGIN_CONTROL_POLICY_APPROVED_ONLY']/*"/>
|
|
<unmanaged>MF_RESOLUTION_PLUGIN_CONTROL_POLICY_APPROVED_ONLY</unmanaged>
|
|
<unmanaged-short>MF_RESOLUTION_PLUGIN_CONTROL_POLICY_APPROVED_ONLY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceResolverFlags.PluginControlPolicyWebOnly">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_RESOLUTION_PLUGIN_CONTROL_POLICY_WEB_ONLY']/*"/>
|
|
<unmanaged>MF_RESOLUTION_PLUGIN_CONTROL_POLICY_WEB_ONLY</unmanaged>
|
|
<unmanaged-short>MF_RESOLUTION_PLUGIN_CONTROL_POLICY_WEB_ONLY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceResolverFlags.Read">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_RESOLUTION_READ']/*"/>
|
|
<unmanaged>MF_RESOLUTION_READ</unmanaged>
|
|
<unmanaged-short>MF_RESOLUTION_READ</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceResolverFlags.Write">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_RESOLUTION_WRITE']/*"/>
|
|
<unmanaged>MF_RESOLUTION_WRITE</unmanaged>
|
|
<unmanaged-short>MF_RESOLUTION_WRITE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceResolverFlags.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.MediaFoundation.StandardVideoFormat">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStandardVideoFormat']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFStandardVideoFormat</unmanaged>
|
|
<unmanaged-short>MFStandardVideoFormat</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StandardVideoFormat.DVideoFormatReserved">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStdVideoFormat_reserved']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFStdVideoFormat_reserved</unmanaged>
|
|
<unmanaged-short>MFStdVideoFormat_reserved</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StandardVideoFormat.DVideoFormatNtsc">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStdVideoFormat_NTSC']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFStdVideoFormat_NTSC</unmanaged>
|
|
<unmanaged-short>MFStdVideoFormat_NTSC</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StandardVideoFormat.DVideoFormatPal">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStdVideoFormat_PAL']/*"/>
|
|
<unmanaged>MFStdVideoFormat_PAL</unmanaged>
|
|
<unmanaged-short>MFStdVideoFormat_PAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StandardVideoFormat.DVideoFormatDvdNtsc">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStdVideoFormat_DVD_NTSC']/*"/>
|
|
<unmanaged>MFStdVideoFormat_DVD_NTSC</unmanaged>
|
|
<unmanaged-short>MFStdVideoFormat_DVD_NTSC</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StandardVideoFormat.DVideoFormatDvdPal">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStdVideoFormat_DVD_PAL']/*"/>
|
|
<unmanaged>MFStdVideoFormat_DVD_PAL</unmanaged>
|
|
<unmanaged-short>MFStdVideoFormat_DVD_PAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StandardVideoFormat.DVideoFormatDvPal">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStdVideoFormat_DV_PAL']/*"/>
|
|
<unmanaged>MFStdVideoFormat_DV_PAL</unmanaged>
|
|
<unmanaged-short>MFStdVideoFormat_DV_PAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StandardVideoFormat.DVideoFormatDvNtsc">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStdVideoFormat_DV_NTSC']/*"/>
|
|
<unmanaged>MFStdVideoFormat_DV_NTSC</unmanaged>
|
|
<unmanaged-short>MFStdVideoFormat_DV_NTSC</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StandardVideoFormat.DVideoFormatAtscSD480i">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStdVideoFormat_ATSC_SD480i']/*"/>
|
|
<unmanaged>MFStdVideoFormat_ATSC_SD480i</unmanaged>
|
|
<unmanaged-short>MFStdVideoFormat_ATSC_SD480i</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StandardVideoFormat.DVideoFormatAtscHD1080i">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStdVideoFormat_ATSC_HD1080i']/*"/>
|
|
<unmanaged>MFStdVideoFormat_ATSC_HD1080i</unmanaged>
|
|
<unmanaged-short>MFStdVideoFormat_ATSC_HD1080i</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StandardVideoFormat.DVideoFormatAtscHD720p">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStdVideoFormat_ATSC_HD720p']/*"/>
|
|
<unmanaged>MFStdVideoFormat_ATSC_HD720p</unmanaged>
|
|
<unmanaged-short>MFStdVideoFormat_ATSC_HD720p</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.StreamsinkMarkerType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Places a marker in the stream. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method causes the stream sink to send an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkMarker"/> event after the stream sink consumes all of the samples that were delivered up to this point (before the call to <strong>PlaceMarker</strong>).</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSTREAMSINK_MARKER_TYPE']/*"/>
|
|
<msdn-id>ms703026</msdn-id>
|
|
<unmanaged>MFSTREAMSINK_MARKER_TYPE</unmanaged>
|
|
<unmanaged-short>MFSTREAMSINK_MARKER_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamsinkMarkerType.Default">
|
|
<summary>
|
|
<dd> <p> Specifies the marker type, as a member of the <strong><see cref="T:SharpDX.MediaFoundation.StreamsinkMarkerType"/></strong> enumeration. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSTREAMSINK_MARKER_DEFAULT']/*"/>
|
|
<msdn-id>ms703026</msdn-id>
|
|
<unmanaged>MFSTREAMSINK_MARKER_DEFAULT</unmanaged>
|
|
<unmanaged-short>MFSTREAMSINK_MARKER_DEFAULT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamsinkMarkerType.Endofsegment">
|
|
<summary>
|
|
<dd> <p> Optional reference to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that contains additional information related to the marker. The meaning of this value depends on the marker type. This parameter can be <strong><c>null</c></strong>. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSTREAMSINK_MARKER_ENDOFSEGMENT']/*"/>
|
|
<msdn-id>ms703026</msdn-id>
|
|
<unmanaged>MFSTREAMSINK_MARKER_ENDOFSEGMENT</unmanaged>
|
|
<unmanaged-short>MFSTREAMSINK_MARKER_ENDOFSEGMENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamsinkMarkerType.Tick">
|
|
<summary>
|
|
<dd> <p> Optional reference to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that is attached to the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkMarker"/> event. Call <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetValue(SharpDX.Win32.Variant@)"/></strong> to get this value from the event. The caller can use this information for any purpose. This parameter can be <strong><c>null</c></strong>. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSTREAMSINK_MARKER_TICK']/*"/>
|
|
<msdn-id>ms703026</msdn-id>
|
|
<unmanaged>MFSTREAMSINK_MARKER_TICK</unmanaged>
|
|
<unmanaged-short>MFSTREAMSINK_MARKER_TICK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamsinkMarkerType.Event">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSTREAMSINK_MARKER_EVENT']/*"/>
|
|
<unmanaged>MFSTREAMSINK_MARKER_EVENT</unmanaged>
|
|
<unmanaged-short>MFSTREAMSINK_MARKER_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TimerFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTIMER_FLAGS']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFTIMER_FLAGS</unmanaged>
|
|
<unmanaged-short>MFTIMER_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TimerFlags.Relative">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTIMER_RELATIVE']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFTIMER_RELATIVE</unmanaged>
|
|
<unmanaged-short>MFTIMER_RELATIVE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TimerFlags.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.MediaFoundation.TMessageType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sends a message to the Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> Before calling this method, set the media types on all input and output streams. </p><p> The MFT might ignore certain message types. If so, the method returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. An error code indicates that the transform handles this message type but was unable to process the message in this instance. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTProcessMessage</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_TYPE']/*"/>
|
|
<msdn-id>ms701863</msdn-id>
|
|
<unmanaged>MFT_MESSAGE_TYPE</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TMessageType.CommandFlush">
|
|
<summary>
|
|
<dd> <p> The message to send, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.TMessageType"/></strong> enumeration. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_COMMAND_FLUSH']/*"/>
|
|
<msdn-id>ms701863</msdn-id>
|
|
<unmanaged>MFT_MESSAGE_COMMAND_FLUSH</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_COMMAND_FLUSH</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TMessageType.CommandDrain">
|
|
<summary>
|
|
<dd> <p> Message parameter. The meaning of this parameter depends on the message type. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_COMMAND_DRAIN']/*"/>
|
|
<msdn-id>ms701863</msdn-id>
|
|
<unmanaged>MFT_MESSAGE_COMMAND_DRAIN</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_COMMAND_DRAIN</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TMessageType.SetD3DManager">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_SET_D3D_MANAGER']/*"/>
|
|
<unmanaged>MFT_MESSAGE_SET_D3D_MANAGER</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_SET_D3D_MANAGER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TMessageType.DropSamples">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_DROP_SAMPLES']/*"/>
|
|
<unmanaged>MFT_MESSAGE_DROP_SAMPLES</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_DROP_SAMPLES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TMessageType.CommandTick">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_COMMAND_TICK']/*"/>
|
|
<unmanaged>MFT_MESSAGE_COMMAND_TICK</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_COMMAND_TICK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TMessageType.NotifyBeginStreaming">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_NOTIFY_BEGIN_STREAMING']/*"/>
|
|
<unmanaged>MFT_MESSAGE_NOTIFY_BEGIN_STREAMING</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_NOTIFY_BEGIN_STREAMING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TMessageType.NotifyEndStreaming">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_NOTIFY_END_STREAMING']/*"/>
|
|
<unmanaged>MFT_MESSAGE_NOTIFY_END_STREAMING</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_NOTIFY_END_STREAMING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TMessageType.NotifyEndOfStream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_NOTIFY_END_OF_STREAM']/*"/>
|
|
<unmanaged>MFT_MESSAGE_NOTIFY_END_OF_STREAM</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_NOTIFY_END_OF_STREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TMessageType.NotifyStartOfStream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_NOTIFY_START_OF_STREAM']/*"/>
|
|
<unmanaged>MFT_MESSAGE_NOTIFY_START_OF_STREAM</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_NOTIFY_START_OF_STREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TMessageType.CommandMarker">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_MESSAGE_COMMAND_MARKER']/*"/>
|
|
<unmanaged>MFT_MESSAGE_COMMAND_MARKER</unmanaged>
|
|
<unmanaged-short>MFT_MESSAGE_COMMAND_MARKER</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TopologyDxvaMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Specifies whether the topology loader enables Microsoft DirectX Video Acceleration (DXVA) in the topology.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This enumeration is used with the <see cref="F:SharpDX.MediaFoundation.TopologyAttributeKeys.DXVAMode"/> topology attribute.</p><p>If an MFT supports DXVA, the MFT must return <strong>TRUE</strong> for the <strong><see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.D3DAware"/></strong> attribute. To enable DXVA, the topology loader calls <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessMessage(SharpDX.MediaFoundation.TMessageType,System.IntPtr)"/></strong> on the MFT, passing the MFT a reference to the <strong>IDirect3DDeviceManager9</strong> interface. The topology loader gets the <strong>IDirect3DDeviceManager9</strong> reference from the media sink for the video stream. Typically the enhanced video renderer (EVR) is the media sink.</p><p>Previous versions of Microsoft Media Foundation supported DXVA only for decoders.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPOLOGY_DXVA_MODE']/*"/>
|
|
<msdn-id>dd388653</msdn-id>
|
|
<unmanaged>MFTOPOLOGY_DXVA_MODE</unmanaged>
|
|
<unmanaged-short>MFTOPOLOGY_DXVA_MODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyDxvaMode.Default">
|
|
<summary>
|
|
<dd> <p>The topology loader enables DXVA
|
|
on the decoder if possible, and drops optional Media Foundation transforms (MFTs) that do not support DXVA.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPOLOGY_DXVA_DEFAULT']/*"/>
|
|
<msdn-id>dd388653</msdn-id>
|
|
<unmanaged>MFTOPOLOGY_DXVA_DEFAULT</unmanaged>
|
|
<unmanaged-short>MFTOPOLOGY_DXVA_DEFAULT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyDxvaMode.None">
|
|
<summary>
|
|
<dd> <p>The topology loader disables all video acceleration. This setting forces software processing, even when the decoder supports DXVA.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPOLOGY_DXVA_NONE']/*"/>
|
|
<msdn-id>dd388653</msdn-id>
|
|
<unmanaged>MFTOPOLOGY_DXVA_NONE</unmanaged>
|
|
<unmanaged-short>MFTOPOLOGY_DXVA_NONE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyDxvaMode.Full">
|
|
<summary>
|
|
<dd> <p>The topology loader enables DXVA on every MFT that supports it.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPOLOGY_DXVA_FULL']/*"/>
|
|
<msdn-id>dd388653</msdn-id>
|
|
<unmanaged>MFTOPOLOGY_DXVA_FULL</unmanaged>
|
|
<unmanaged-short>MFTOPOLOGY_DXVA_FULL</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TopologyHardwareMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Specifies whether the topology loader will insert hardware-based Media Foundation transforms (MFTs) into the topology.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> This enumeration is used with the <see cref="F:SharpDX.MediaFoundation.TopologyAttributeKeys.HardwareMode"/> topology attribute. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPOLOGY_HARDWARE_MODE']/*"/>
|
|
<msdn-id>dd388654</msdn-id>
|
|
<unmanaged>MFTOPOLOGY_HARDWARE_MODE</unmanaged>
|
|
<unmanaged-short>MFTOPOLOGY_HARDWARE_MODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyHardwareMode.WmodeSoftwareOnly">
|
|
<summary>
|
|
<dd> <p>Use only software MFTs. Do not use hardware-based MFTs. This mode is the default, for backward compatibility with existing applications.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPOLOGY_HWMODE_SOFTWARE_ONLY']/*"/>
|
|
<msdn-id>dd388654</msdn-id>
|
|
<unmanaged>MFTOPOLOGY_HWMODE_SOFTWARE_ONLY</unmanaged>
|
|
<unmanaged-short>MFTOPOLOGY_HWMODE_SOFTWARE_ONLY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyHardwareMode.WmodeUseHardware">
|
|
<summary>
|
|
<dd> <p>Use hardware-based MFTs when possible, and software MFTs otherwise. This mode is the recommended one.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPOLOGY_HWMODE_USE_HARDWARE']/*"/>
|
|
<msdn-id>dd388654</msdn-id>
|
|
<unmanaged>MFTOPOLOGY_HWMODE_USE_HARDWARE</unmanaged>
|
|
<unmanaged-short>MFTOPOLOGY_HWMODE_USE_HARDWARE</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TopologyResolutionStatusFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines status flags for the <strong><see cref="F:SharpDX.MediaFoundation.TopologyAttributeKeys.ResolutionStatus"/></strong> attribute.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOLOGY_RESOLUTION_STATUS_FLAGS']/*"/>
|
|
<msdn-id>ms704637</msdn-id>
|
|
<unmanaged>MF_TOPOLOGY_RESOLUTION_STATUS_FLAGS</unmanaged>
|
|
<unmanaged-short>MF_TOPOLOGY_RESOLUTION_STATUS_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyResolutionStatusFlags.MfTopologyResolutionSucceeded">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOLOGY_RESOLUTION_SUCCEEDED']/*"/>
|
|
<unmanaged>MF_TOPOLOGY_RESOLUTION_SUCCEEDED</unmanaged>
|
|
<unmanaged-short>MF_TOPOLOGY_RESOLUTION_SUCCEEDED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyResolutionStatusFlags.MfOptionalNodeRejectedMediaType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPTIONAL_NODE_REJECTED_MEDIA_TYPE']/*"/>
|
|
<unmanaged>MF_OPTIONAL_NODE_REJECTED_MEDIA_TYPE</unmanaged>
|
|
<unmanaged-short>MF_OPTIONAL_NODE_REJECTED_MEDIA_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyResolutionStatusFlags.MfOptionalNodeRejectedProtectedProcess">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_OPTIONAL_NODE_REJECTED_PROTECTED_PROCESS']/*"/>
|
|
<unmanaged>MF_OPTIONAL_NODE_REJECTED_PROTECTED_PROCESS</unmanaged>
|
|
<unmanaged-short>MF_OPTIONAL_NODE_REJECTED_PROTECTED_PROCESS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyResolutionStatusFlags.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.MediaFoundation.TopologyType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines the type of a topology node.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOLOGY_TYPE']/*"/>
|
|
<msdn-id>ms698973</msdn-id>
|
|
<unmanaged>MF_TOPOLOGY_TYPE</unmanaged>
|
|
<unmanaged-short>MF_TOPOLOGY_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyType.OutputNode">
|
|
<summary>
|
|
<dd> <p>Output node. Represents a media sink in the topology.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOLOGY_OUTPUT_NODE']/*"/>
|
|
<msdn-id>ms698973</msdn-id>
|
|
<unmanaged>MF_TOPOLOGY_OUTPUT_NODE</unmanaged>
|
|
<unmanaged-short>MF_TOPOLOGY_OUTPUT_NODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyType.SourcestreamNode">
|
|
<summary>
|
|
<dd> <p>Source node. Represents a media stream in the topology.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOLOGY_SOURCESTREAM_NODE']/*"/>
|
|
<msdn-id>ms698973</msdn-id>
|
|
<unmanaged>MF_TOPOLOGY_SOURCESTREAM_NODE</unmanaged>
|
|
<unmanaged-short>MF_TOPOLOGY_SOURCESTREAM_NODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyType.TransformNode">
|
|
<summary>
|
|
<dd> <p>Transform node. Represents a Media Foundation Transform (MFT) in the topology.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOLOGY_TRANSFORM_NODE']/*"/>
|
|
<msdn-id>ms698973</msdn-id>
|
|
<unmanaged>MF_TOPOLOGY_TRANSFORM_NODE</unmanaged>
|
|
<unmanaged-short>MF_TOPOLOGY_TRANSFORM_NODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyType.TeeNode">
|
|
<summary>
|
|
<dd> <p>Tee node. A tee node does not hold a reference to an object. Instead, it represents a fork in the stream. A tee node has one input and multiple outputs, and samples from the upstream node are delivered to all of the downstream nodes.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOLOGY_TEE_NODE']/*"/>
|
|
<msdn-id>ms698973</msdn-id>
|
|
<unmanaged>MF_TOPOLOGY_TEE_NODE</unmanaged>
|
|
<unmanaged-short>MF_TOPOLOGY_TEE_NODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyType.Maximum">
|
|
<summary>
|
|
<dd> <p>Reserved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOLOGY_MAX']/*"/>
|
|
<msdn-id>ms698973</msdn-id>
|
|
<unmanaged>MF_TOPOLOGY_MAX</unmanaged>
|
|
<unmanaged-short>MF_TOPOLOGY_MAX</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ToponodeDrainMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines at what times a transform in a topology is drained.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPONODE_DRAIN_MODE']/*"/>
|
|
<msdn-id>aa370822</msdn-id>
|
|
<unmanaged>MF_TOPONODE_DRAIN_MODE</unmanaged>
|
|
<unmanaged-short>MF_TOPONODE_DRAIN_MODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeDrainMode.Default">
|
|
<summary>
|
|
<dd> <p>The transform is drained when the end of a stream is reached. It is not drained when markout is reached at the end of a segment.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPONODE_DRAIN_DEFAULT']/*"/>
|
|
<msdn-id>aa370822</msdn-id>
|
|
<unmanaged>MF_TOPONODE_DRAIN_DEFAULT</unmanaged>
|
|
<unmanaged-short>MF_TOPONODE_DRAIN_DEFAULT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeDrainMode.Always">
|
|
<summary>
|
|
<dd> <p>The transform is drained whenever a topology ends.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPONODE_DRAIN_ALWAYS']/*"/>
|
|
<msdn-id>aa370822</msdn-id>
|
|
<unmanaged>MF_TOPONODE_DRAIN_ALWAYS</unmanaged>
|
|
<unmanaged-short>MF_TOPONODE_DRAIN_ALWAYS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeDrainMode.Never">
|
|
<summary>
|
|
<dd> <p>The transform is never drained.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPONODE_DRAIN_NEVER']/*"/>
|
|
<msdn-id>aa370822</msdn-id>
|
|
<unmanaged>MF_TOPONODE_DRAIN_NEVER</unmanaged>
|
|
<unmanaged-short>MF_TOPONODE_DRAIN_NEVER</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ToponodeFlushMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines when a transform in a topology is flushed.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPONODE_FLUSH_MODE']/*"/>
|
|
<msdn-id>ms704760</msdn-id>
|
|
<unmanaged>MF_TOPONODE_FLUSH_MODE</unmanaged>
|
|
<unmanaged-short>MF_TOPONODE_FLUSH_MODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeFlushMode.Always">
|
|
<summary>
|
|
<dd> <p>The transform is flushed whenever the stream changes, including seeks and new segments.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPONODE_FLUSH_ALWAYS']/*"/>
|
|
<msdn-id>ms704760</msdn-id>
|
|
<unmanaged>MF_TOPONODE_FLUSH_ALWAYS</unmanaged>
|
|
<unmanaged-short>MF_TOPONODE_FLUSH_ALWAYS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeFlushMode.Seek">
|
|
<summary>
|
|
<dd> <p>The transform is flushed when seeking is performed on the stream.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPONODE_FLUSH_SEEK']/*"/>
|
|
<msdn-id>ms704760</msdn-id>
|
|
<unmanaged>MF_TOPONODE_FLUSH_SEEK</unmanaged>
|
|
<unmanaged-short>MF_TOPONODE_FLUSH_SEEK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeFlushMode.Never">
|
|
<summary>
|
|
<dd> <p>The transform is never flushed during streaming. It is flushed only when the object is released.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPONODE_FLUSH_NEVER']/*"/>
|
|
<msdn-id>ms704760</msdn-id>
|
|
<unmanaged>MF_TOPONODE_FLUSH_NEVER</unmanaged>
|
|
<unmanaged-short>MF_TOPONODE_FLUSH_NEVER</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Topostatus">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies the status of a topology during playback. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> This enumeration is used with the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologyStatus"/> event. The <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologyStatus"/> event always has an <strong><see cref="F:SharpDX.MediaFoundation.EventAttributeKeys.TopologyStatus"/></strong> attribute whose value is a member of this enumeration. </p><p> For a single topology, the Media Session sends these status flags in numerical order, starting with <strong><see cref="F:SharpDX.MediaFoundation.Topostatus.Ready"/></strong>. However, there is no guarantee about the ordering of the events across two different topologies. For example, you might get <strong><see cref="F:SharpDX.MediaFoundation.Topostatus.Ready"/></strong> for a topology before you get <strong><see cref="F:SharpDX.MediaFoundation.Topostatus.Ended"/></strong> for the previous topology. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOSTATUS']/*"/>
|
|
<msdn-id>aa370812</msdn-id>
|
|
<unmanaged>MF_TOPOSTATUS</unmanaged>
|
|
<unmanaged-short>MF_TOPOSTATUS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Topostatus.Invalid">
|
|
<summary>
|
|
<dd> <p> This value is not used. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOSTATUS_INVALID']/*"/>
|
|
<msdn-id>aa370812</msdn-id>
|
|
<unmanaged>MF_TOPOSTATUS_INVALID</unmanaged>
|
|
<unmanaged-short>MF_TOPOSTATUS_INVALID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Topostatus.Ready">
|
|
<summary>
|
|
<dd> <p> The topology is ready to start. After this status flag is received, you can use the Media Session's <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> method to query the topology for services, such as rate control. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOSTATUS_READY']/*"/>
|
|
<msdn-id>aa370812</msdn-id>
|
|
<unmanaged>MF_TOPOSTATUS_READY</unmanaged>
|
|
<unmanaged-short>MF_TOPOSTATUS_READY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Topostatus.StartedSource">
|
|
<summary>
|
|
<dd> <p> The Media Session has started to read data from the media sources in the topology. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOSTATUS_STARTED_SOURCE']/*"/>
|
|
<msdn-id>aa370812</msdn-id>
|
|
<unmanaged>MF_TOPOSTATUS_STARTED_SOURCE</unmanaged>
|
|
<unmanaged-short>MF_TOPOSTATUS_STARTED_SOURCE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Topostatus.DynamicChanged">
|
|
<summary>
|
|
<dd> <p>The Media Session modified the topology, because the format of a stream changed.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOSTATUS_DYNAMIC_CHANGED']/*"/>
|
|
<msdn-id>aa370812</msdn-id>
|
|
<unmanaged>MF_TOPOSTATUS_DYNAMIC_CHANGED</unmanaged>
|
|
<unmanaged-short>MF_TOPOSTATUS_DYNAMIC_CHANGED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Topostatus.SinkSwitched">
|
|
<summary>
|
|
<dd> <p> The media sinks have switched from the previous topology to this topology. This status value is not sent for the first topology that is played. For the first topology, the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionStarted"/> event indicates that the media sinks have started receiving data. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOSTATUS_SINK_SWITCHED']/*"/>
|
|
<msdn-id>aa370812</msdn-id>
|
|
<unmanaged>MF_TOPOSTATUS_SINK_SWITCHED</unmanaged>
|
|
<unmanaged-short>MF_TOPOSTATUS_SINK_SWITCHED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Topostatus.Ended">
|
|
<summary>
|
|
<dd> <p> Playback of this topology is complete. The Media Session might still use the topology internally. The Media Session does not completely release the topology until it sends the next <strong><see cref="F:SharpDX.MediaFoundation.Topostatus.StartedSource"/></strong> status event or the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionEnded"/> event. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TOPOSTATUS_ENDED']/*"/>
|
|
<msdn-id>aa370812</msdn-id>
|
|
<unmanaged>MF_TOPOSTATUS_ENDED</unmanaged>
|
|
<unmanaged-short>MF_TOPOSTATUS_ENDED</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TranscodeAdjustProfileFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Defines the profile flags that are set in the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeAdjustProfile"/> attribute.</p><p>These flags are checked by <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeTopology(SharpDX.MediaFoundation.MediaSource,System.String,SharpDX.MediaFoundation.TranscodeProfile,SharpDX.MediaFoundation.Topology@)"/></strong> during topology building. Based on these flags, <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeTopology(SharpDX.MediaFoundation.MediaSource,System.String,SharpDX.MediaFoundation.TranscodeProfile,SharpDX.MediaFoundation.Topology@)"/></strong> adjusts the transcode profile by modifying the configuration settings for the streams according to the input requirements of the encoder used in the topology. </p><p>For more information about the stream settings that an application can specify, see Using the Transcode API.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the <strong><see cref="F:SharpDX.MediaFoundation.TranscodeAdjustProfileFlags.Default"/></strong> flag is specified, the following changes are made for the video stream:</p><ul> <li>If the frame rate of the media source specified in the <em>pSrc</em> parameter of <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeTopology(SharpDX.MediaFoundation.MediaSource,System.String,SharpDX.MediaFoundation.TranscodeProfile,SharpDX.MediaFoundation.Topology@)"/></strong> and the frame rate specified by the application in the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.FrameRate"/></strong> attribute differ by less than 1/1000, the profile uses the media source frame rate. This is because the pipeline considers the difference to be negligible.</li> <li>If the application does not specify an interlaced mode by setting the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.InterlaceMode"/></strong> attribute, the profile is changed to use progressive frames.</li> </ul><p>The <strong><see cref="F:SharpDX.MediaFoundation.TranscodeAdjustProfileFlags.Default"/></strong> flag must be accompanied with the required audio and video stream attributes provided by the application. For the audio stream, the required attributes are as follows:</p><ul> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioNumChannels"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioSamplesPerSecond"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioBlockAlignment"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioAvgBytesPerSecond"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioBitsPerSample"/></strong> </li> </ul><p> For the video stream, the required attributes are as follows:</p><ul> <li><strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.FrameRate"/></strong></li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.FrameSize"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AvgBitrate"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.PixelAspectRatio"/></strong> </li> </ul><p> If these attributes are not set, <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeTopology(SharpDX.MediaFoundation.MediaSource,System.String,SharpDX.MediaFoundation.TranscodeProfile,SharpDX.MediaFoundation.Topology@)"/></strong> creates the topology but Media Session fails to generate the encoded file. The failure code depends on the MFT node in the topology. For example, if the application does not set the frame size, the WMV encoder fails to encode the content and application gets the MF_E_INVALIDMEDIATYPE error code through the Media Session. </p><p>Use the <strong><see cref="F:SharpDX.MediaFoundation.TranscodeAdjustProfileFlags.UseSourceAttributes"/></strong> flag when you want to transcode the file by using the input stream attributes. The input source stream attributes are copied to the output media type before the MFT node is inserted in the topology. If you set additional stream attributes, this flag does not overwrite the set values. Only the missing attributes are filled with the input source's attribute values. This flag is useful in remux scenario where you want to generate the output file in the same format as the input source. If you want to perform format conversion, make sure you set the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Subtype"/></strong> attribute for the stream to specify the encoder that topology builder must use. The transform node is added in the topology unless <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeDonotInsertEncoder"/> is set. In this case, and the content is not encoded. Instead, if permitted by the container, the content is embedded in the specified container. </p><p>For example, assume that your input source is an MP3 file. You set the container to be <strong>MFTranscodeContainerType_ASF</strong>, you do not set any stream attributes, and you set the <strong><see cref="F:SharpDX.MediaFoundation.TranscodeAdjustProfileFlags.UseSourceAttributes"/></strong> flag. In this case, the generated output file is an ASF file (.wma) containing MP3 media data. Note that if you use this flag, certain input stream attributes and the container type might not be compatible. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_ADJUST_PROFILE_FLAGS']/*"/>
|
|
<msdn-id>dd388918</msdn-id>
|
|
<unmanaged>MF_TRANSCODE_ADJUST_PROFILE_FLAGS</unmanaged>
|
|
<unmanaged-short>MF_TRANSCODE_ADJUST_PROFILE_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeAdjustProfileFlags.Default">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_ADJUST_PROFILE_DEFAULT']/*"/>
|
|
<unmanaged>MF_TRANSCODE_ADJUST_PROFILE_DEFAULT</unmanaged>
|
|
<unmanaged-short>MF_TRANSCODE_ADJUST_PROFILE_DEFAULT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeAdjustProfileFlags.UseSourceAttributes">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_ADJUST_PROFILE_USE_SOURCE_ATTRIBUTES']/*"/>
|
|
<unmanaged>MF_TRANSCODE_ADJUST_PROFILE_USE_SOURCE_ATTRIBUTES</unmanaged>
|
|
<unmanaged-short>MF_TRANSCODE_ADJUST_PROFILE_USE_SOURCE_ATTRIBUTES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeAdjustProfileFlags.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.MediaFoundation.TranscodeTopologymodeFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Defines flags for the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeTopologymode"/> attribute.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_TOPOLOGYMODE_FLAGS']/*"/>
|
|
<msdn-id>dd388926</msdn-id>
|
|
<unmanaged>MF_TRANSCODE_TOPOLOGYMODE_FLAGS</unmanaged>
|
|
<unmanaged-short>MF_TRANSCODE_TOPOLOGYMODE_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeTopologymodeFlags.SoftwareOnly">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_TOPOLOGYMODE_SOFTWARE_ONLY']/*"/>
|
|
<unmanaged>MF_TRANSCODE_TOPOLOGYMODE_SOFTWARE_ONLY</unmanaged>
|
|
<unmanaged-short>MF_TRANSCODE_TOPOLOGYMODE_SOFTWARE_ONLY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeTopologymodeFlags.HardwareAllowed">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_TOPOLOGYMODE_HARDWARE_ALLOWED']/*"/>
|
|
<unmanaged>MF_TRANSCODE_TOPOLOGYMODE_HARDWARE_ALLOWED</unmanaged>
|
|
<unmanaged-short>MF_TRANSCODE_TOPOLOGYMODE_HARDWARE_ALLOWED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeTopologymodeFlags.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.MediaFoundation.UrlTrustStatus">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a URL for performing a manual content enabling action.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the enabling action can be performed by navigating to a URL, this method returns the URL. If no such URL exists, the method returns a failure code.</p><p>The purpose of the URL depends on the content enabler type, which is obtained by calling <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableType(System.Guid@)"/></strong>.</p><table> <tr><th>Enable type</th><th>Purpose of URL</th></tr> <tr><td>Individualization</td><td>Not applicable.</td></tr> <tr><td>License acquisition</td><td>URL to obtain the license. Call <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableData(System.Byte[],System.Int32@)"/></strong> and submit the data to the URL as an HTTP POST request. To receive notification when the license is acquired, call <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.MonitorEnable"/></strong>.</td></tr> <tr><td>Revocation</td><td>URL to a webpage where the user can download and install an updated component.</td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_URL_TRUST_STATUS']/*"/>
|
|
<msdn-id>bb970345</msdn-id>
|
|
<unmanaged>MF_URL_TRUST_STATUS</unmanaged>
|
|
<unmanaged-short>MF_URL_TRUST_STATUS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.UrlTrustStatus.MfLicenseUrlUntrusted">
|
|
<summary>
|
|
<dd> <p>Receives a reference to a buffer that contains the URL. The caller must release the memory for the buffer by calling <strong>CoTaskMemFree</strong>.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_LICENSE_URL_UNTRUSTED']/*"/>
|
|
<msdn-id>bb970345</msdn-id>
|
|
<unmanaged>MF_LICENSE_URL_UNTRUSTED</unmanaged>
|
|
<unmanaged-short>MF_LICENSE_URL_UNTRUSTED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.UrlTrustStatus.MfLicenseUrlTrusted">
|
|
<summary>
|
|
<dd> <p>Receives the number of characters returned in <em>ppwszURL</em>, including the terminating <c>null</c> character.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_LICENSE_URL_TRUSTED']/*"/>
|
|
<msdn-id>bb970345</msdn-id>
|
|
<unmanaged>MF_LICENSE_URL_TRUSTED</unmanaged>
|
|
<unmanaged-short>MF_LICENSE_URL_TRUSTED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.UrlTrustStatus.MfLicenseUrlTampered">
|
|
<summary>
|
|
<dd> <p>Receives a member of the <strong><see cref="T:SharpDX.MediaFoundation.UrlTrustStatus"/></strong> enumeration indicating whether the URL is trusted.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_LICENSE_URL_TAMPERED']/*"/>
|
|
<msdn-id>bb970345</msdn-id>
|
|
<unmanaged>MF_LICENSE_URL_TAMPERED</unmanaged>
|
|
<unmanaged-short>MF_LICENSE_URL_TAMPERED</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Video3DFormat">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideo3DFormat']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideo3DFormat</unmanaged>
|
|
<unmanaged-short>MFVideo3DFormat</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Video3DFormat.SampleFormatBaseView">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideo3DSampleFormat_BaseView']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideo3DSampleFormat_BaseView</unmanaged>
|
|
<unmanaged-short>MFVideo3DSampleFormat_BaseView</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Video3DFormat.SampleFormatMultiView">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideo3DSampleFormat_MultiView']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideo3DSampleFormat_MultiView</unmanaged>
|
|
<unmanaged-short>MFVideo3DSampleFormat_MultiView</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Video3DFormat.SampleFormatPackedLeftRight">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideo3DSampleFormat_Packed_LeftRight']/*"/>
|
|
<unmanaged>MFVideo3DSampleFormat_Packed_LeftRight</unmanaged>
|
|
<unmanaged-short>MFVideo3DSampleFormat_Packed_LeftRight</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Video3DFormat.SampleFormatPackedTopBottom">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideo3DSampleFormat_Packed_TopBottom']/*"/>
|
|
<unmanaged>MFVideo3DSampleFormat_Packed_TopBottom</unmanaged>
|
|
<unmanaged-short>MFVideo3DSampleFormat_Packed_TopBottom</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Video3DOutputType">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>The video processor MFT is a Microsoft Media Foundation transform (MFT) that performs colorspace conversion, video resizing, deinterlacing, frame rate conversion, rotation, cropping, spatial left and right view unpacking, and mirroring.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>An instance of the video processor can be created in one of the following ways: </p><ul> <li>By calling <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong>. The video processor is registered under the <strong>MFT_CATEGORY_VIDEO_PROCESSOR</strong> category.</li> <li>By calling the COM function <strong>CoCreateInstance</strong> passing it the CLSID <strong>CLSID_VideoProcessorMFT</strong>.</li> </ul><p>The video processor supports GPU-accelerated video processing, using Microsoft Direct3D?11. For more information, see <see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.D3D11Aware"/>.</p>Stereoscopic Video<p>The video processor supports the view unpacking operation on 3D video frames:</p><p>If the input frame contains two views packed in the same frame, the video processor can split the views into separate buffers, or extract the base view and discard the second view. To enable view unpacking, set the <see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.Enable3dvideoOutput"/> attribute to <strong><see cref="F:SharpDX.MediaFoundation.Video3DOutputType.Stereo"/></strong> or <strong><see cref="F:SharpDX.MediaFoundation.Video3DOutputType.BaseView"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF3DVideoOutputType']/*"/>
|
|
<msdn-id>hh162913</msdn-id>
|
|
<unmanaged>MF3DVideoOutputType</unmanaged>
|
|
<unmanaged-short>MF3DVideoOutputType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Video3DOutputType.BaseView">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF3DVideoOutputType_BaseView']/*"/>
|
|
<unmanaged>MF3DVideoOutputType_BaseView</unmanaged>
|
|
<unmanaged-short>MF3DVideoOutputType_BaseView</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Video3DOutputType.Stereo">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF3DVideoOutputType_Stereo']/*"/>
|
|
<unmanaged>MF3DVideoOutputType_Stereo</unmanaged>
|
|
<unmanaged-short>MF3DVideoOutputType_Stereo</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Video3DSampleFormat">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideo3DSampleFormat']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideo3DSampleFormat</unmanaged>
|
|
<unmanaged-short>MFVideo3DSampleFormat</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Video3DSampleFormat.MFSampleExtension3DVideoMultiView">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSampleExtension_3DVideo_MultiView']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFSampleExtension_3DVideo_MultiView</unmanaged>
|
|
<unmanaged-short>MFSampleExtension_3DVideo_MultiView</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Video3DSampleFormat.MFSampleExtension3DVideoPacked">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSampleExtension_3DVideo_Packed']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFSampleExtension_3DVideo_Packed</unmanaged>
|
|
<unmanaged-short>MFSampleExtension_3DVideo_Packed</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoAspectRatioMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Specifies the aspect-ratio mode.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoAspectRatioMode']/*"/>
|
|
<msdn-id>ms703040</msdn-id>
|
|
<unmanaged>MFVideoAspectRatioMode</unmanaged>
|
|
<unmanaged-short>MFVideoAspectRatioMode</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoAspectRatioMode.RModeNone">
|
|
<summary>
|
|
<dd> <p>Do not maintain the aspect ratio of the video. Stretch the video to fit the output rectangle.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoARMode_None']/*"/>
|
|
<msdn-id>ms703040</msdn-id>
|
|
<unmanaged>MFVideoARMode_None</unmanaged>
|
|
<unmanaged-short>MFVideoARMode_None</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoAspectRatioMode.RModePreservePicture">
|
|
<summary>
|
|
<dd> <p>Preserve the aspect ratio of the video by letterboxing or within the output rectangle.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoARMode_PreservePicture']/*"/>
|
|
<msdn-id>ms703040</msdn-id>
|
|
<unmanaged>MFVideoARMode_PreservePicture</unmanaged>
|
|
<unmanaged-short>MFVideoARMode_PreservePicture</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoAspectRatioMode.RModePreservePixel">
|
|
<summary>
|
|
<dd> <p><strong>Note</strong>??Currently the EVR ignores this flag.</p> <p>Correct the aspect ratio if the physical size of the display device does not match the display resolution. For example, if the native resolution of the monitor is 1600 by 1200 (4:3) but the display resolution is 1280 by 1024 (5:4), the monitor will display non-square pixels.</p> <p>If this flag is set, you must also set the <strong><see cref="F:SharpDX.MediaFoundation.VideoAspectRatioMode.RModePreservePicture"/></strong> flag.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoARMode_PreservePixel']/*"/>
|
|
<msdn-id>ms703040</msdn-id>
|
|
<unmanaged>MFVideoARMode_PreservePixel</unmanaged>
|
|
<unmanaged-short>MFVideoARMode_PreservePixel</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoAspectRatioMode.RModeNonLinearStretch">
|
|
<summary>
|
|
<dd> <p>Apply a non-linear horizontal stretch if the aspect ratio of the destination rectangle does not match the aspect ratio of the source rectangle.</p> <p>The non-linear stretch algorithm preserves the aspect ratio in the middle of the picture and stretches (or shrinks) the image progressively more toward the left and right. This mode is useful when viewing 4:3 content full-screen on a 16:9 display, instead of pillar-boxing. Non-linear vertical stretch is not supported, because the visual results are generally poor.</p> <p>This mode may cause performance degradation.</p> <p>If this flag is set, you must also set the <strong><see cref="F:SharpDX.MediaFoundation.VideoAspectRatioMode.RModePreservePixel"/></strong> and <strong><see cref="F:SharpDX.MediaFoundation.VideoAspectRatioMode.RModePreservePicture"/></strong> flags.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoARMode_NonLinearStretch']/*"/>
|
|
<msdn-id>ms703040</msdn-id>
|
|
<unmanaged>MFVideoARMode_NonLinearStretch</unmanaged>
|
|
<unmanaged-short>MFVideoARMode_NonLinearStretch</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoChromaSubsampling">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains flags that define the chroma encoding scheme for Y'Cb'Cr' data.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>These flags are used with the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.VideoChromaSiting"/></strong> attribute.</p><p>For more information about these values, see the remarks for the <strong>DXVA2_VideoChromaSubSampling</strong> enumeration, which is the DirectX Video Acceleration (DXVA) equivalent of this enumeration.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.Unknown">
|
|
<summary>
|
|
<dd> <p>Unknown encoding scheme.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_Unknown']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_Unknown</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_Unknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.ProgressiveChroma">
|
|
<summary>
|
|
<dd> <p>Chroma should be reconstructed as if the underlying video was progressive content, rather than skipping fields or applying chroma filtering to minimize artifacts from reconstructing 4:2:0 interlaced chroma.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_ProgressiveChroma']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_ProgressiveChroma</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_ProgressiveChroma</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.HorizontallyCosited">
|
|
<summary>
|
|
<dd> <p>Chroma samples are aligned horizontally with the luma samples, or with multiples of the luma samples. If this flag is not set, chroma samples are located 1/2 pixel to the right of the corresponding luma sample.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_Horizontally_Cosited']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_Horizontally_Cosited</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_Horizontally_Cosited</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.VerticallyCosited">
|
|
<summary>
|
|
<dd> <p>Chroma samples are aligned vertically with the luma samples, or with multiples of the luma samples. If this flag is not set, chroma samples are located 1/2 pixel down from the corresponding luma sample.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_Vertically_Cosited']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_Vertically_Cosited</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_Vertically_Cosited</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.VerticallyAlignedChromaPlanes">
|
|
<summary>
|
|
<dd> <p>The U and V planes are aligned vertically. If this flag is not set, the chroma planes are assumed to be out of phase by 1/2 chroma sample, alternating between a line of U followed by a line of V.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_Vertically_AlignedChromaPlanes']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_Vertically_AlignedChromaPlanes</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_Vertically_AlignedChromaPlanes</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.Mpeg2">
|
|
<summary>
|
|
<dd> <p>Specifies the chroma encoding scheme for MPEG-2 video. Chroma samples are aligned horizontally with the luma samples, but are not aligned vertically. The U and V planes are aligned vertically.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_MPEG2']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_MPEG2</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_MPEG2</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.Mpeg1">
|
|
<summary>
|
|
<dd> <p>Specifies the chroma encoding scheme for MPEG-1 video.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_MPEG1']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_MPEG1</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_MPEG1</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.DvPal">
|
|
<summary>
|
|
<dd> <p>Specifies the chroma encoding scheme for PAL DV video.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_DV_PAL']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_DV_PAL</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_DV_PAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.Cosited">
|
|
<summary>
|
|
<dd> <p>Chroma samples are aligned vertically and horizontally with the luma samples. YUV formats such as 4:4:4, 4:2:2, and 4:1:1 are always cosited in both directions and should use this flag.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_Cosited']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_Cosited</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_Cosited</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.Last">
|
|
<summary>
|
|
<dd> <p>Reserved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_Last']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_Last</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_Last</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoChromaSubsampling.ForceDWORD">
|
|
<summary>
|
|
<dd> <p>Reserved. This member forces the enumeration type to compile as a <strong>DWORD</strong> value.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoChromaSubsampling_ForceDWORD']/*"/>
|
|
<msdn-id>ms698989</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling_ForceDWORD</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling_ForceDWORD</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoDRMFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoDRMFlags']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoDRMFlags</unmanaged>
|
|
<unmanaged-short>MFVideoDRMFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoDRMFlags.None">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoDRMFlag_None']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoDRMFlag_None</unmanaged>
|
|
<unmanaged-short>MFVideoDRMFlag_None</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoDRMFlags.AnalogProtected">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoDRMFlag_AnalogProtected']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoDRMFlag_AnalogProtected</unmanaged>
|
|
<unmanaged-short>MFVideoDRMFlag_AnalogProtected</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoDRMFlags.DigitallyProtected">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoDRMFlag_DigitallyProtected']/*"/>
|
|
<unmanaged>MFVideoDRMFlag_DigitallyProtected</unmanaged>
|
|
<unmanaged-short>MFVideoDRMFlag_DigitallyProtected</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates a video media type from a <strong><see cref="T:SharpDX.Win32.BitmapInfoHeader"/></strong> structure.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlags']/*"/>
|
|
<msdn-id>dd388121</msdn-id>
|
|
<unmanaged>MFVideoFlags</unmanaged>
|
|
<unmanaged-short>MFVideoFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.PadToNone">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_PAD_TO_None']/*"/>
|
|
<unmanaged>MFVideoFlag_PAD_TO_None</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_PAD_TO_None</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.PadTo4x3">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_PAD_TO_4x3']/*"/>
|
|
<unmanaged>MFVideoFlag_PAD_TO_4x3</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_PAD_TO_4x3</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.PadTo16x9">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_PAD_TO_16x9']/*"/>
|
|
<unmanaged>MFVideoFlag_PAD_TO_16x9</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_PAD_TO_16x9</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.SrcContentHintMask">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_SrcContentHintMask']/*"/>
|
|
<unmanaged>MFVideoFlag_SrcContentHintMask</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_SrcContentHintMask</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.SrcContentHintNone">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_SrcContentHintNone']/*"/>
|
|
<unmanaged>MFVideoFlag_SrcContentHintNone</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_SrcContentHintNone</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.SrcContentHint16x9">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_SrcContentHint16x9']/*"/>
|
|
<unmanaged>MFVideoFlag_SrcContentHint16x9</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_SrcContentHint16x9</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.SrcContentHint2351">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_SrcContentHint235_1']/*"/>
|
|
<unmanaged>MFVideoFlag_SrcContentHint235_1</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_SrcContentHint235_1</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.AnalogProtected">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_AnalogProtected']/*"/>
|
|
<unmanaged>MFVideoFlag_AnalogProtected</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_AnalogProtected</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.DigitallyProtected">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_DigitallyProtected']/*"/>
|
|
<unmanaged>MFVideoFlag_DigitallyProtected</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_DigitallyProtected</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.ProgressiveContent">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_ProgressiveContent']/*"/>
|
|
<unmanaged>MFVideoFlag_ProgressiveContent</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_ProgressiveContent</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.FieldRepeatCountMask">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_FieldRepeatCountMask']/*"/>
|
|
<unmanaged>MFVideoFlag_FieldRepeatCountMask</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_FieldRepeatCountMask</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.FieldRepeatCountShift">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_FieldRepeatCountShift']/*"/>
|
|
<unmanaged>MFVideoFlag_FieldRepeatCountShift</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_FieldRepeatCountShift</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.ProgressiveSeqReset">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_ProgressiveSeqReset']/*"/>
|
|
<unmanaged>MFVideoFlag_ProgressiveSeqReset</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_ProgressiveSeqReset</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.PanScanEnabled">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_PanScanEnabled']/*"/>
|
|
<unmanaged>MFVideoFlag_PanScanEnabled</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_PanScanEnabled</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.LowerFieldFirst">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_LowerFieldFirst']/*"/>
|
|
<unmanaged>MFVideoFlag_LowerFieldFirst</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_LowerFieldFirst</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.BottomUpLinearRep">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlag_BottomUpLinearRep']/*"/>
|
|
<unmanaged>MFVideoFlag_BottomUpLinearRep</unmanaged>
|
|
<unmanaged-short>MFVideoFlag_BottomUpLinearRep</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.SDXVASurface">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlags_DXVASurface']/*"/>
|
|
<unmanaged>MFVideoFlags_DXVASurface</unmanaged>
|
|
<unmanaged-short>MFVideoFlags_DXVASurface</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.SRenderTargetSurface">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlags_RenderTargetSurface']/*"/>
|
|
<unmanaged>MFVideoFlags_RenderTargetSurface</unmanaged>
|
|
<unmanaged-short>MFVideoFlags_RenderTargetSurface</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoFlags.SForceQWORD">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoFlags_ForceQWORD']/*"/>
|
|
<unmanaged>MFVideoFlags_ForceQWORD</unmanaged>
|
|
<unmanaged-short>MFVideoFlags_ForceQWORD</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoInterlaceMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Specifies how a video stream is interlaced.</p><p>In the descriptions that follow, upper field refers to the field that contains the leading half scan line. Lower field refers to the field that contains the first full scan line.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Scan lines in the lower field are 0.5 scan line lower than those in the upper field. In NTSC television, a frame consists of a lower field followed by an upper field. In PAL television, a frame consists of an upper field followed by a lower field.</p><p>The upper field is also called the even field, the top field, or field 2. The lower field is also called the odd field, the bottom field, or field 1.</p><p>If the interlace mode is <see cref="F:SharpDX.MediaFoundation.VideoInterlaceMode.FieldSingleUpper"/> or <see cref="F:SharpDX.MediaFoundation.VideoInterlaceMode.FieldSingleLower"/>, each sample contains a single field, so each buffer contains only half the number of field lines given in the media type.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInterlaceMode']/*"/>
|
|
<msdn-id>ms694269</msdn-id>
|
|
<unmanaged>MFVideoInterlaceMode</unmanaged>
|
|
<unmanaged-short>MFVideoInterlaceMode</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInterlaceMode.Unknown">
|
|
<summary>
|
|
<dd> <p> The type of interlacing is not known. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInterlace_Unknown']/*"/>
|
|
<msdn-id>ms694269</msdn-id>
|
|
<unmanaged>MFVideoInterlace_Unknown</unmanaged>
|
|
<unmanaged-short>MFVideoInterlace_Unknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInterlaceMode.Progressive">
|
|
<summary>
|
|
<dd> <p> Progressive frames. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInterlace_Progressive']/*"/>
|
|
<msdn-id>ms694269</msdn-id>
|
|
<unmanaged>MFVideoInterlace_Progressive</unmanaged>
|
|
<unmanaged-short>MFVideoInterlace_Progressive</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInterlaceMode.FieldInterleavedUpperFirst">
|
|
<summary>
|
|
<dd> <p> Interlaced frames. Each frame contains two fields. The field lines are interleaved, with the upper field appearing on the first line. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInterlace_FieldInterleavedUpperFirst']/*"/>
|
|
<msdn-id>ms694269</msdn-id>
|
|
<unmanaged>MFVideoInterlace_FieldInterleavedUpperFirst</unmanaged>
|
|
<unmanaged-short>MFVideoInterlace_FieldInterleavedUpperFirst</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInterlaceMode.FieldInterleavedLowerFirst">
|
|
<summary>
|
|
<dd> <p> Interlaced frames. Each frame contains two fields. The field lines are interleaved, with the lower field appearing on the first line. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInterlace_FieldInterleavedLowerFirst']/*"/>
|
|
<msdn-id>ms694269</msdn-id>
|
|
<unmanaged>MFVideoInterlace_FieldInterleavedLowerFirst</unmanaged>
|
|
<unmanaged-short>MFVideoInterlace_FieldInterleavedLowerFirst</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInterlaceMode.FieldSingleUpper">
|
|
<summary>
|
|
<dd> <p> Interlaced frames. Each frame contains one field, with the upper field appearing first. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInterlace_FieldSingleUpper']/*"/>
|
|
<msdn-id>ms694269</msdn-id>
|
|
<unmanaged>MFVideoInterlace_FieldSingleUpper</unmanaged>
|
|
<unmanaged-short>MFVideoInterlace_FieldSingleUpper</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInterlaceMode.FieldSingleLower">
|
|
<summary>
|
|
<dd> <p> Interlaced frames. Each frame contains one field, with the lower field appearing first. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInterlace_FieldSingleLower']/*"/>
|
|
<msdn-id>ms694269</msdn-id>
|
|
<unmanaged>MFVideoInterlace_FieldSingleLower</unmanaged>
|
|
<unmanaged-short>MFVideoInterlace_FieldSingleLower</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInterlaceMode.MixedInterlaceOrProgressive">
|
|
<summary>
|
|
<dd> <p> The stream contains a mix of interlaced and progressive modes. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInterlace_MixedInterlaceOrProgressive']/*"/>
|
|
<msdn-id>ms694269</msdn-id>
|
|
<unmanaged>MFVideoInterlace_MixedInterlaceOrProgressive</unmanaged>
|
|
<unmanaged-short>MFVideoInterlace_MixedInterlaceOrProgressive</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInterlaceMode.Last">
|
|
<summary>
|
|
<dd> <p> Reserved. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInterlace_Last']/*"/>
|
|
<msdn-id>ms694269</msdn-id>
|
|
<unmanaged>MFVideoInterlace_Last</unmanaged>
|
|
<unmanaged-short>MFVideoInterlace_Last</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInterlaceMode.ForceDWORD">
|
|
<summary>
|
|
<dd> <p> Reserved. This member forces the enumeration type to compile as a <strong>DWORD</strong> value. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInterlace_ForceDWORD']/*"/>
|
|
<msdn-id>ms694269</msdn-id>
|
|
<unmanaged>MFVideoInterlace_ForceDWORD</unmanaged>
|
|
<unmanaged-short>MFVideoInterlace_ForceDWORD</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoLighting">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoLighting']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoLighting</unmanaged>
|
|
<unmanaged-short>MFVideoLighting</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoLighting.Unknown">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoLighting_Unknown']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoLighting_Unknown</unmanaged>
|
|
<unmanaged-short>MFVideoLighting_Unknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoLighting.Bright">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoLighting_bright']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoLighting_bright</unmanaged>
|
|
<unmanaged-short>MFVideoLighting_bright</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoLighting.Office">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoLighting_office']/*"/>
|
|
<unmanaged>MFVideoLighting_office</unmanaged>
|
|
<unmanaged-short>MFVideoLighting_office</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoLighting.Dim">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoLighting_dim']/*"/>
|
|
<unmanaged>MFVideoLighting_dim</unmanaged>
|
|
<unmanaged-short>MFVideoLighting_dim</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoLighting.Dark">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoLighting_dark']/*"/>
|
|
<unmanaged>MFVideoLighting_dark</unmanaged>
|
|
<unmanaged-short>MFVideoLighting_dark</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoLighting.Last">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoLighting_Last']/*"/>
|
|
<unmanaged>MFVideoLighting_Last</unmanaged>
|
|
<unmanaged-short>MFVideoLighting_Last</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoLighting.ForceDWORD">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoLighting_ForceDWORD']/*"/>
|
|
<unmanaged>MFVideoLighting_ForceDWORD</unmanaged>
|
|
<unmanaged-short>MFVideoLighting_ForceDWORD</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoMixPrefs">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains flags that are used to configure how the enhanced video renderer (EVR) performs deinterlacing.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To set these flags, call the <strong><see cref="M:SharpDX.MediaFoundation.VideoMixerControl2.SetMixingPrefs(System.Int32)"/></strong> method.</p><p>These flags control some trade-offs between video quality and rendering speed. The constants named "MFVideoMixPrefs_Allow..." enable lower-quality settings, but only when the quality manager requests a drop in quality. The constants named "MFVideoMixPrefs_Force..." force the EVR to use lower-quality settings regardless of what the quality manager requests. (For more information about the quality manager, see <strong><see cref="T:SharpDX.MediaFoundation.QualityAdvise"/></strong>.)</p><p>Currently two lower-quality modes are supported, as described in the following table. Either is preferable to dropping an entire frame.</p><p></p><table> <tr><th>Mode</th><th>Description</th></tr> <tr><td> <p>Half interface</p> </td><td> <p>The EVR's video mixer skips the second field (relative to temporal order) of each interlaced frame. The video mixer still deinterlaces the first field, and this operation typically interpolates data from the second field. The overall frame rate is unaffected.</p> </td></tr> <tr><td> <p>Bob deinterlacing</p> </td><td> <p>The video mixer uses bob deinterlacing, even if the driver supports a higher-quality deinterlacing algorithm.</p> </td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoMixPrefs']/*"/>
|
|
<msdn-id>dd388675</msdn-id>
|
|
<unmanaged>MFVideoMixPrefs</unmanaged>
|
|
<unmanaged-short>MFVideoMixPrefs</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoMixPrefs.ForceHalfInterlace">
|
|
<summary>
|
|
<dd> <p>Force the EVR to skip the second field (in temporal order) of every interlaced frame. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoMixPrefs_ForceHalfInterlace']/*"/>
|
|
<msdn-id>dd388675</msdn-id>
|
|
<unmanaged>MFVideoMixPrefs_ForceHalfInterlace</unmanaged>
|
|
<unmanaged-short>MFVideoMixPrefs_ForceHalfInterlace</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoMixPrefs.AllowDropToHalfInterlace">
|
|
<summary>
|
|
<dd> <p>If the EVR is falling behind, allow it to skip the second field (in temporal order) of every interlaced frame.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoMixPrefs_AllowDropToHalfInterlace']/*"/>
|
|
<msdn-id>dd388675</msdn-id>
|
|
<unmanaged>MFVideoMixPrefs_AllowDropToHalfInterlace</unmanaged>
|
|
<unmanaged-short>MFVideoMixPrefs_AllowDropToHalfInterlace</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoMixPrefs.AllowDropToBob">
|
|
<summary>
|
|
<dd> <p>If the EVR is falling behind, allow it to use bob deinterlacing, even if the driver supports a higher-quality deinterlacing mode.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoMixPrefs_AllowDropToBob']/*"/>
|
|
<msdn-id>dd388675</msdn-id>
|
|
<unmanaged>MFVideoMixPrefs_AllowDropToBob</unmanaged>
|
|
<unmanaged-short>MFVideoMixPrefs_AllowDropToBob</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoMixPrefs.ForceBob">
|
|
<summary>
|
|
<dd> <p>Force the EVR to use bob deinterlacing, even if the driver supports a higher-quality mode.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoMixPrefs_ForceBob']/*"/>
|
|
<msdn-id>dd388675</msdn-id>
|
|
<unmanaged>MFVideoMixPrefs_ForceBob</unmanaged>
|
|
<unmanaged-short>MFVideoMixPrefs_ForceBob</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoMixPrefs.EnableRotation">
|
|
<summary>
|
|
<dd> <p>The bitmask of valid flag values. This constant is not itself a valid flag.
|
|
</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoMixPrefs_EnableRotation']/*"/>
|
|
<msdn-id>dd388675</msdn-id>
|
|
<unmanaged>MFVideoMixPrefs_EnableRotation</unmanaged>
|
|
<unmanaged-short>MFVideoMixPrefs_EnableRotation</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoPadFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPadFlags']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoPadFlags</unmanaged>
|
|
<unmanaged-short>MFVideoPadFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPadFlags.PadToNone">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPadFlag_PAD_TO_None']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoPadFlag_PAD_TO_None</unmanaged>
|
|
<unmanaged-short>MFVideoPadFlag_PAD_TO_None</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPadFlags.PadTo4x3">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPadFlag_PAD_TO_4x3']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoPadFlag_PAD_TO_4x3</unmanaged>
|
|
<unmanaged-short>MFVideoPadFlag_PAD_TO_4x3</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPadFlags.PadTo16x9">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPadFlag_PAD_TO_16x9']/*"/>
|
|
<unmanaged>MFVideoPadFlag_PAD_TO_16x9</unmanaged>
|
|
<unmanaged-short>MFVideoPadFlag_PAD_TO_16x9</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoPrimaries">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoPrimaries</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.Unknown">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_Unknown']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoPrimaries_Unknown</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_Unknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.Reserved">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_reserved']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoPrimaries_reserved</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_reserved</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.Bt709">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_BT709']/*"/>
|
|
<unmanaged>MFVideoPrimaries_BT709</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_BT709</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.Bt4702SysM">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_BT470_2_SysM']/*"/>
|
|
<unmanaged>MFVideoPrimaries_BT470_2_SysM</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_BT470_2_SysM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.Bt4702SysBG">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_BT470_2_SysBG']/*"/>
|
|
<unmanaged>MFVideoPrimaries_BT470_2_SysBG</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_BT470_2_SysBG</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.Smpte170m">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_SMPTE170M']/*"/>
|
|
<unmanaged>MFVideoPrimaries_SMPTE170M</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_SMPTE170M</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.Smpte240m">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_SMPTE240M']/*"/>
|
|
<unmanaged>MFVideoPrimaries_SMPTE240M</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_SMPTE240M</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.Ebu3213">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_EBU3213']/*"/>
|
|
<unmanaged>MFVideoPrimaries_EBU3213</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_EBU3213</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.SmpteC">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_SMPTE_C']/*"/>
|
|
<unmanaged>MFVideoPrimaries_SMPTE_C</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_SMPTE_C</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.Last">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_Last']/*"/>
|
|
<unmanaged>MFVideoPrimaries_Last</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_Last</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoPrimaries.ForceDWORD">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoPrimaries_ForceDWORD']/*"/>
|
|
<unmanaged>MFVideoPrimaries_ForceDWORD</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries_ForceDWORD</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoProcessorMirror">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Specifies how to flip a video image.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_VIDEO_PROCESSOR_MIRROR']/*"/>
|
|
<msdn-id>hh162904</msdn-id>
|
|
<unmanaged>MF_VIDEO_PROCESSOR_MIRROR</unmanaged>
|
|
<unmanaged-short>MF_VIDEO_PROCESSOR_MIRROR</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoProcessorMirror.MirrorNone">
|
|
<summary>
|
|
<dd> <p>Do not flip the image.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MIRROR_NONE']/*"/>
|
|
<msdn-id>hh162904</msdn-id>
|
|
<unmanaged>MIRROR_NONE</unmanaged>
|
|
<unmanaged-short>MIRROR_NONE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoProcessorMirror.MirrorHorizontal">
|
|
<summary>
|
|
<dd> <p>Flip the image horizontally.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MIRROR_HORIZONTAL']/*"/>
|
|
<msdn-id>hh162904</msdn-id>
|
|
<unmanaged>MIRROR_HORIZONTAL</unmanaged>
|
|
<unmanaged-short>MIRROR_HORIZONTAL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoProcessorMirror.MirrorVertical">
|
|
<summary>
|
|
<dd> <p>Flip the image vertically.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MIRROR_VERTICAL']/*"/>
|
|
<msdn-id>hh162904</msdn-id>
|
|
<unmanaged>MIRROR_VERTICAL</unmanaged>
|
|
<unmanaged-short>MIRROR_VERTICAL</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoProcessorRotation">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Specifies how to rotate a video image.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_VIDEO_PROCESSOR_ROTATION']/*"/>
|
|
<msdn-id>hh162905</msdn-id>
|
|
<unmanaged>MF_VIDEO_PROCESSOR_ROTATION</unmanaged>
|
|
<unmanaged-short>MF_VIDEO_PROCESSOR_ROTATION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoProcessorRotation.RotationNone">
|
|
<summary>
|
|
<dd> <p>Do not rotate the image.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ROTATION_NONE']/*"/>
|
|
<msdn-id>hh162905</msdn-id>
|
|
<unmanaged>ROTATION_NONE</unmanaged>
|
|
<unmanaged-short>ROTATION_NONE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoProcessorRotation.RotationNormal">
|
|
<summary>
|
|
<dd> <p>Rotate the image to the correct viewing orientation.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ROTATION_NORMAL']/*"/>
|
|
<msdn-id>hh162905</msdn-id>
|
|
<unmanaged>ROTATION_NORMAL</unmanaged>
|
|
<unmanaged-short>ROTATION_NORMAL</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoRenderPrefs">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains flags that define how the enhanced video renderer (EVR) displays the video.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To set these flags, call <strong><see cref="M:SharpDX.MediaFoundation.VideoDisplayControl.SetRenderingPrefs(System.Int32)"/></strong>.</p><p>The flags named "MFVideoRenderPrefs_Allow..." cause the EVR to use lower-quality settings only when requested by the quality manager. (For more information, see <strong><see cref="T:SharpDX.MediaFoundation.QualityAdvise"/></strong>.) The flags named "MFVideoRenderPrefs_Force..." cause the video mixer to use lower-quality settings regardless of the quality manager. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRenderPrefs']/*"/>
|
|
<msdn-id>ms701834</msdn-id>
|
|
<unmanaged>MFVideoRenderPrefs</unmanaged>
|
|
<unmanaged-short>MFVideoRenderPrefs</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRenderPrefs.DoNotRenderBorder">
|
|
<summary>
|
|
<dd> <p> If this flag is set, the EVR does not draw the border color. By default, the EVR draws a border on areas of the destination rectangle that have no video. See <strong><see cref="M:SharpDX.MediaFoundation.VideoDisplayControl.SetBorderColor(SharpDX.Color4)"/></strong>. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRenderPrefs_DoNotRenderBorder']/*"/>
|
|
<msdn-id>ms701834</msdn-id>
|
|
<unmanaged>MFVideoRenderPrefs_DoNotRenderBorder</unmanaged>
|
|
<unmanaged-short>MFVideoRenderPrefs_DoNotRenderBorder</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRenderPrefs.DoNotClipToDevice">
|
|
<summary>
|
|
<dd> <p> If this flag is set, the EVR does not clip the video when the video window straddles two monitors. By default, if the video window straddles two monitors, the EVR clips the video to the monitor that contains the largest area of video. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRenderPrefs_DoNotClipToDevice']/*"/>
|
|
<msdn-id>ms701834</msdn-id>
|
|
<unmanaged>MFVideoRenderPrefs_DoNotClipToDevice</unmanaged>
|
|
<unmanaged-short>MFVideoRenderPrefs_DoNotClipToDevice</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRenderPrefs.AllowOutputThrottling">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>Allow the EVR to limit its output to match GPU bandwidth.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRenderPrefs_AllowOutputThrottling']/*"/>
|
|
<msdn-id>ms701834</msdn-id>
|
|
<unmanaged>MFVideoRenderPrefs_AllowOutputThrottling</unmanaged>
|
|
<unmanaged-short>MFVideoRenderPrefs_AllowOutputThrottling</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRenderPrefs.ForceOutputThrottling">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>Force the EVR to limit its output to match GPU bandwidth.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRenderPrefs_ForceOutputThrottling']/*"/>
|
|
<msdn-id>ms701834</msdn-id>
|
|
<unmanaged>MFVideoRenderPrefs_ForceOutputThrottling</unmanaged>
|
|
<unmanaged-short>MFVideoRenderPrefs_ForceOutputThrottling</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRenderPrefs.ForceBatching">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>Force the EVR to batch Direct3D <strong>Present</strong> calls. This optimization enables the system to enter to idle states more frequently, which can reduce power consumption. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRenderPrefs_ForceBatching']/*"/>
|
|
<msdn-id>ms701834</msdn-id>
|
|
<unmanaged>MFVideoRenderPrefs_ForceBatching</unmanaged>
|
|
<unmanaged-short>MFVideoRenderPrefs_ForceBatching</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRenderPrefs.AllowBatching">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>Allow the EVR to batch Direct3D <strong>Present</strong> calls.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRenderPrefs_AllowBatching']/*"/>
|
|
<msdn-id>ms701834</msdn-id>
|
|
<unmanaged>MFVideoRenderPrefs_AllowBatching</unmanaged>
|
|
<unmanaged-short>MFVideoRenderPrefs_AllowBatching</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRenderPrefs.ForceScaling">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>Force the EVR to mix the video inside a rectangle that is smaller than the output rectangle. The EVR will then scale the result to the correct output size. The effective resolution will be lower if this setting is applied.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRenderPrefs_ForceScaling']/*"/>
|
|
<msdn-id>ms701834</msdn-id>
|
|
<unmanaged>MFVideoRenderPrefs_ForceScaling</unmanaged>
|
|
<unmanaged-short>MFVideoRenderPrefs_ForceScaling</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRenderPrefs.AllowScaling">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>Allow the EVR to mix the video inside a rectangle that is smaller than the output rectangle. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRenderPrefs_AllowScaling']/*"/>
|
|
<msdn-id>ms701834</msdn-id>
|
|
<unmanaged>MFVideoRenderPrefs_AllowScaling</unmanaged>
|
|
<unmanaged-short>MFVideoRenderPrefs_AllowScaling</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRenderPrefs.DoNotRepaintOnStop">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>Prevent the EVR from repainting the video window after a stop command. By default, the EVR repaints the video window black after a stop command.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRenderPrefs_DoNotRepaintOnStop']/*"/>
|
|
<msdn-id>ms701834</msdn-id>
|
|
<unmanaged>MFVideoRenderPrefs_DoNotRepaintOnStop</unmanaged>
|
|
<unmanaged-short>MFVideoRenderPrefs_DoNotRepaintOnStop</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoRotationFormat">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRotationFormat']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoRotationFormat</unmanaged>
|
|
<unmanaged-short>MFVideoRotationFormat</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRotationFormat.Angle0">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRotationFormat_0']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoRotationFormat_0</unmanaged>
|
|
<unmanaged-short>MFVideoRotationFormat_0</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRotationFormat.Angle90">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRotationFormat_90']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoRotationFormat_90</unmanaged>
|
|
<unmanaged-short>MFVideoRotationFormat_90</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRotationFormat.Angle180">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRotationFormat_180']/*"/>
|
|
<unmanaged>MFVideoRotationFormat_180</unmanaged>
|
|
<unmanaged-short>MFVideoRotationFormat_180</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoRotationFormat.Angle270">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoRotationFormat_270']/*"/>
|
|
<unmanaged>MFVideoRotationFormat_270</unmanaged>
|
|
<unmanaged-short>MFVideoRotationFormat_270</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoSrcContentHintFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoSrcContentHintFlags']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoSrcContentHintFlags</unmanaged>
|
|
<unmanaged-short>MFVideoSrcContentHintFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoSrcContentHintFlags.None">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoSrcContentHintFlag_None']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoSrcContentHintFlag_None</unmanaged>
|
|
<unmanaged-short>MFVideoSrcContentHintFlag_None</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoSrcContentHintFlags.Hint16x9">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoSrcContentHintFlag_16x9']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoSrcContentHintFlag_16x9</unmanaged>
|
|
<unmanaged-short>MFVideoSrcContentHintFlag_16x9</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoSrcContentHintFlags.Hint235_1">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoSrcContentHintFlag_235_1']/*"/>
|
|
<unmanaged>MFVideoSrcContentHintFlag_235_1</unmanaged>
|
|
<unmanaged-short>MFVideoSrcContentHintFlag_235_1</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoTransferFunction">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransferFunction']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoTransferFunction</unmanaged>
|
|
<unmanaged-short>MFVideoTransferFunction</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.FuncUnknown">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_Unknown']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoTransFunc_Unknown</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_Unknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.Func10">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_10']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoTransFunc_10</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_10</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.Func18">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_18']/*"/>
|
|
<unmanaged>MFVideoTransFunc_18</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_18</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.Func20">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_20']/*"/>
|
|
<unmanaged>MFVideoTransFunc_20</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_20</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.Func22">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_22']/*"/>
|
|
<unmanaged>MFVideoTransFunc_22</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_22</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.Func709">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_709']/*"/>
|
|
<unmanaged>MFVideoTransFunc_709</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_709</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.Func240m">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_240M']/*"/>
|
|
<unmanaged>MFVideoTransFunc_240M</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_240M</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.FuncSRGB">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_sRGB']/*"/>
|
|
<unmanaged>MFVideoTransFunc_sRGB</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_sRGB</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.Func28">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_28']/*"/>
|
|
<unmanaged>MFVideoTransFunc_28</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_28</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.FuncLog100">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_Log_100']/*"/>
|
|
<unmanaged>MFVideoTransFunc_Log_100</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_Log_100</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.FuncLog316">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_Log_316']/*"/>
|
|
<unmanaged>MFVideoTransFunc_Log_316</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_Log_316</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.Func709Sym">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_709_sym']/*"/>
|
|
<unmanaged>MFVideoTransFunc_709_sym</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_709_sym</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.FuncLast">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_Last']/*"/>
|
|
<unmanaged>MFVideoTransFunc_Last</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_Last</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferFunction.FuncForceDWORD">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransFunc_ForceDWORD']/*"/>
|
|
<unmanaged>MFVideoTransFunc_ForceDWORD</unmanaged>
|
|
<unmanaged-short>MFVideoTransFunc_ForceDWORD</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoTransferMatrix">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransferMatrix']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoTransferMatrix</unmanaged>
|
|
<unmanaged-short>MFVideoTransferMatrix</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferMatrix.Unknown">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransferMatrix_Unknown']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoTransferMatrix_Unknown</unmanaged>
|
|
<unmanaged-short>MFVideoTransferMatrix_Unknown</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferMatrix.Bt709">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransferMatrix_BT709']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFVideoTransferMatrix_BT709</unmanaged>
|
|
<unmanaged-short>MFVideoTransferMatrix_BT709</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferMatrix.Bt601">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransferMatrix_BT601']/*"/>
|
|
<unmanaged>MFVideoTransferMatrix_BT601</unmanaged>
|
|
<unmanaged-short>MFVideoTransferMatrix_BT601</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferMatrix.Smpte240m">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransferMatrix_SMPTE240M']/*"/>
|
|
<unmanaged>MFVideoTransferMatrix_SMPTE240M</unmanaged>
|
|
<unmanaged-short>MFVideoTransferMatrix_SMPTE240M</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferMatrix.Last">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransferMatrix_Last']/*"/>
|
|
<unmanaged>MFVideoTransferMatrix_Last</unmanaged>
|
|
<unmanaged-short>MFVideoTransferMatrix_Last</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoTransferMatrix.ForceDWORD">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoTransferMatrix_ForceDWORD']/*"/>
|
|
<unmanaged>MFVideoTransferMatrix_ForceDWORD</unmanaged>
|
|
<unmanaged-short>MFVideoTransferMatrix_ForceDWORD</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VpMessageType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Defines messages for an enhanced video renderer (EVR) presenter. This enumeration is used with the <strong><see cref="M:SharpDX.MediaFoundation.VideoPresenter.ProcessMessage(SharpDX.MediaFoundation.VpMessageType,System.IntPtr)"/></strong> method.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVP_MESSAGE_TYPE']/*"/>
|
|
<msdn-id>ms698964</msdn-id>
|
|
<unmanaged>MFVP_MESSAGE_TYPE</unmanaged>
|
|
<unmanaged-short>MFVP_MESSAGE_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VpMessageType.Flush">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVP_MESSAGE_FLUSH']/*"/>
|
|
<unmanaged>MFVP_MESSAGE_FLUSH</unmanaged>
|
|
<unmanaged-short>MFVP_MESSAGE_FLUSH</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VpMessageType.Invalidatemediatype">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVP_MESSAGE_INVALIDATEMEDIATYPE']/*"/>
|
|
<unmanaged>MFVP_MESSAGE_INVALIDATEMEDIATYPE</unmanaged>
|
|
<unmanaged-short>MFVP_MESSAGE_INVALIDATEMEDIATYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VpMessageType.Processinputnotify">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVP_MESSAGE_PROCESSINPUTNOTIFY']/*"/>
|
|
<unmanaged>MFVP_MESSAGE_PROCESSINPUTNOTIFY</unmanaged>
|
|
<unmanaged-short>MFVP_MESSAGE_PROCESSINPUTNOTIFY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VpMessageType.Beginstreaming">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVP_MESSAGE_BEGINSTREAMING']/*"/>
|
|
<unmanaged>MFVP_MESSAGE_BEGINSTREAMING</unmanaged>
|
|
<unmanaged-short>MFVP_MESSAGE_BEGINSTREAMING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VpMessageType.Endstreaming">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVP_MESSAGE_ENDSTREAMING']/*"/>
|
|
<unmanaged>MFVP_MESSAGE_ENDSTREAMING</unmanaged>
|
|
<unmanaged-short>MFVP_MESSAGE_ENDSTREAMING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VpMessageType.Endofstream">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVP_MESSAGE_ENDOFSTREAM']/*"/>
|
|
<unmanaged>MFVP_MESSAGE_ENDOFSTREAM</unmanaged>
|
|
<unmanaged-short>MFVP_MESSAGE_ENDOFSTREAM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VpMessageType.Step">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVP_MESSAGE_STEP']/*"/>
|
|
<unmanaged>MFVP_MESSAGE_STEP</unmanaged>
|
|
<unmanaged-short>MFVP_MESSAGE_STEP</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VpMessageType.Cancelstep">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVP_MESSAGE_CANCELSTEP']/*"/>
|
|
<unmanaged>MFVP_MESSAGE_CANCELSTEP</unmanaged>
|
|
<unmanaged-short>MFVP_MESSAGE_CANCELSTEP</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.WaveFormatExConvertFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies how the credential manager should obtain user credentials. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application implements the credential manager, which must expose the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. If the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag is set, the credential manager should prompt the user for his or her name and password.</p><p>The credential cache object sets the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialRequirements.RequirePrompt"/></strong> flag if the cache does not yet contain valid credentials. It also sets this flag if the credentials will be sent as plain text, unless the credential manager previously set the <strong><see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/></strong> option. (See <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFWaveFormatExConvertFlags']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFWaveFormatExConvertFlags</unmanaged>
|
|
<unmanaged-short>MFWaveFormatExConvertFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.WaveFormatExConvertFlags.Normal">
|
|
<summary>
|
|
<dd> <p> The credential manager should prompt the user to provide the credentials. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFWaveFormatExConvertFlag_Normal']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFWaveFormatExConvertFlag_Normal</unmanaged>
|
|
<unmanaged-short>MFWaveFormatExConvertFlag_Normal</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.WaveFormatExConvertFlags.ForceExtensible">
|
|
<summary>
|
|
<dd> <p> </p><p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>The credentials are saved to persistent storage. This flag acts as a hint for the application's UI. If the application prompts the user for credentials, the UI can indicate that the credentials have already been saved.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFWaveFormatExConvertFlag_ForceExtensible']/*"/>
|
|
<msdn-id>ms700813</msdn-id>
|
|
<unmanaged>MFWaveFormatExConvertFlag_ForceExtensible</unmanaged>
|
|
<unmanaged-short>MFWaveFormatExConvertFlag_ForceExtensible</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsfProfileAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.AsfProfileAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfProfileAttributeKeys.Maxpacketsize">
|
|
<summary>Constant Maxpacketsize.</summary>
|
|
<unmanaged>MF_ASFPROFILE_MAXPACKETSIZE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfProfileAttributeKeys.Minpacketsize">
|
|
<summary>Constant Minpacketsize.</summary>
|
|
<unmanaged>MF_ASFPROFILE_MINPACKETSIZE</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsfSplitterAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.AsfSplitterAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfSplitterAttributeKeys.PacketBoundary">
|
|
<summary>Constant PacketBoundary.</summary>
|
|
<unmanaged>MFASFSPLITTER_PACKET_BOUNDARY</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsfStreamConfigAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.AsfStreamConfigAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfStreamConfigAttributeKeys.LeakyBucket1">
|
|
<summary>Constant LeakyBucket1.</summary>
|
|
<unmanaged>MF_ASFSTREAMCONFIG_LEAKYBUCKET1</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfStreamConfigAttributeKeys.LeakyBucket2">
|
|
<summary>Constant LeakyBucket2.</summary>
|
|
<unmanaged>MF_ASFSTREAMCONFIG_LEAKYBUCKET2</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AudioRendererAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.AudioRendererAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.EndpointId">
|
|
<summary>Constant EndpointId.</summary>
|
|
<unmanaged>MF_AUDIO_RENDERER_ATTRIBUTE_ENDPOINT_ID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.EndpointRole">
|
|
<summary>Constant EndpointRole.</summary>
|
|
<unmanaged>MF_AUDIO_RENDERER_ATTRIBUTE_ENDPOINT_ROLE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.Flags">
|
|
<summary>Constant Flags.</summary>
|
|
<unmanaged>MF_AUDIO_RENDERER_ATTRIBUTE_FLAGS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.SessionId">
|
|
<summary>Constant SessionId.</summary>
|
|
<unmanaged>MF_AUDIO_RENDERER_ATTRIBUTE_SESSION_ID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.StreamCategory">
|
|
<summary>Constant StreamCategory.</summary>
|
|
<unmanaged>MF_AUDIO_RENDERER_ATTRIBUTE_STREAM_CATEGORY</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ByteStreamAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.ByteStreamAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.ContentType">
|
|
<summary>Constant ContentType.</summary>
|
|
<unmanaged>MF_BYTESTREAM_CONTENT_TYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.Duration">
|
|
<summary>Constant Duration.</summary>
|
|
<unmanaged>MF_BYTESTREAM_DURATION</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.EffectiveUrl">
|
|
<summary>Constant EffectiveUrl.</summary>
|
|
<unmanaged>MF_BYTESTREAM_EFFECTIVE_URL</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.IfoFileUri">
|
|
<summary>Constant IfoFileUri.</summary>
|
|
<unmanaged>MF_BYTESTREAM_IFO_FILE_URI</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.LastModifiedTime">
|
|
<summary>Constant LastModifiedTime.</summary>
|
|
<unmanaged>MF_BYTESTREAM_LAST_MODIFIED_TIME</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.OriginName">
|
|
<summary>Constant OriginName.</summary>
|
|
<unmanaged>MF_BYTESTREAM_ORIGIN_NAME</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.HandlerAcceptsShareWrite">
|
|
<summary>Constant HandlerAcceptsShareWrite.</summary>
|
|
<unmanaged>MF_BYTESTREAMHANDLER_ACCEPTS_SHARE_WRITE</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.CaptureDeviceAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.FriendlyName">
|
|
<summary>Constant FriendlyName.</summary>
|
|
<unmanaged>MF_DEVSOURCE_ATTRIBUTE_FRIENDLY_NAME</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.MediaType">
|
|
<summary>Constant MediaType.</summary>
|
|
<unmanaged>MF_DEVSOURCE_ATTRIBUTE_MEDIA_TYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceType">
|
|
<summary>Constant SourceType.</summary>
|
|
<unmanaged>MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeAudcapEndpointId">
|
|
<summary>Constant SourceTypeAudcapEndpointId.</summary>
|
|
<unmanaged>MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_AUDCAP_ENDPOINT_ID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeAudcapRole">
|
|
<summary>Constant SourceTypeAudcapRole.</summary>
|
|
<unmanaged>MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_AUDCAP_ROLE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapCategory">
|
|
<summary>Constant SourceTypeVidcapCategory.</summary>
|
|
<unmanaged>MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_CATEGORY</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapHwSource">
|
|
<summary>Constant SourceTypeVidcapHwSource.</summary>
|
|
<unmanaged>MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_HW_SOURCE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapMaxBuffers">
|
|
<summary>Constant SourceTypeVidcapMaxBuffers.</summary>
|
|
<unmanaged>MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_MAX_BUFFERS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapSymbolicLink">
|
|
<summary>Constant SourceTypeVidcapSymbolicLink.</summary>
|
|
<unmanaged>MF_DEVSOURCE_ATTRIBUTE_SOURCE_TYPE_VIDCAP_SYMBOLIC_LINK</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.DLNAMediaSinkAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.DLNAMediaSinkAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DLNAMediaSinkAttributeKeys.AudioBitRate">
|
|
<summary>Constant AudioBitRate.</summary>
|
|
<unmanaged>MF_MP2DLNA_AUDIO_BIT_RATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DLNAMediaSinkAttributeKeys.EncodeQuality">
|
|
<summary>Constant EncodeQuality.</summary>
|
|
<unmanaged>MF_MP2DLNA_ENCODE_QUALITY</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DLNAMediaSinkAttributeKeys.Statistics">
|
|
<summary>Constant Statistics.</summary>
|
|
<unmanaged>MF_MP2DLNA_STATISTICS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DLNAMediaSinkAttributeKeys.UseMmcss">
|
|
<summary>Constant UseMmcss.</summary>
|
|
<unmanaged>MF_MP2DLNA_USE_MMCSS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DLNAMediaSinkAttributeKeys.VideoBitRate">
|
|
<summary>Constant VideoBitRate.</summary>
|
|
<unmanaged>MF_MP2DLNA_VIDEO_BIT_RATE</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.EventAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.EventAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.DoThinning">
|
|
<summary>Constant DoThinning.</summary>
|
|
<unmanaged>MF_EVENT_DO_THINNING</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.TransformContext">
|
|
<summary>Constant TransformContext.</summary>
|
|
<unmanaged>MF_EVENT_MFT_CONTEXT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.TransformInputStreamId">
|
|
<summary>Constant TransformInputStreamId.</summary>
|
|
<unmanaged>MF_EVENT_MFT_INPUT_STREAM_ID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.OutputNode">
|
|
<summary>Constant OutputNode.</summary>
|
|
<unmanaged>MF_EVENT_OUTPUT_NODE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.PresentationTimeOffset">
|
|
<summary>Constant PresentationTimeOffset.</summary>
|
|
<unmanaged>MF_EVENT_PRESENTATION_TIME_OFFSET</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.ScrubsampleTime">
|
|
<summary>Constant ScrubsampleTime.</summary>
|
|
<unmanaged>MF_EVENT_SCRUBSAMPLE_TIME</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.Sessioncaps">
|
|
<summary>Constant Sessioncaps.</summary>
|
|
<unmanaged>MF_EVENT_SESSIONCAPS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.SessioncapsDelta">
|
|
<summary>Constant SessioncapsDelta.</summary>
|
|
<unmanaged>MF_EVENT_SESSIONCAPS_DELTA</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.SourceActualStart">
|
|
<summary>Constant SourceActualStart.</summary>
|
|
<unmanaged>MF_EVENT_SOURCE_ACTUAL_START</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.SourceCharacteristics">
|
|
<summary>Constant SourceCharacteristics.</summary>
|
|
<unmanaged>MF_EVENT_SOURCE_CHARACTERISTICS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.SourceCharacteristicsOld">
|
|
<summary>Constant SourceCharacteristicsOld.</summary>
|
|
<unmanaged>MF_EVENT_SOURCE_CHARACTERISTICS_OLD</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.SourceFakeStart">
|
|
<summary>Constant SourceFakeStart.</summary>
|
|
<unmanaged>MF_EVENT_SOURCE_FAKE_START</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.SourceProjectstart">
|
|
<summary>Constant SourceProjectstart.</summary>
|
|
<unmanaged>MF_EVENT_SOURCE_PROJECTSTART</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.SourceTopologyCanceled">
|
|
<summary>Constant SourceTopologyCanceled.</summary>
|
|
<unmanaged>MF_EVENT_SOURCE_TOPOLOGY_CANCELED</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.StartPresentationTime">
|
|
<summary>Constant StartPresentationTime.</summary>
|
|
<unmanaged>MF_EVENT_START_PRESENTATION_TIME</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.StartPresentationTimeAtOutput">
|
|
<summary>Constant StartPresentationTimeAtOutput.</summary>
|
|
<unmanaged>MF_EVENT_START_PRESENTATION_TIME_AT_OUTPUT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EventAttributeKeys.TopologyStatus">
|
|
<summary>Constant TopologyStatus.</summary>
|
|
<unmanaged>MF_EVENT_TOPOLOGY_STATUS</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.EVRAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.EVRAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRAttributeKeys.SaRequiredSampleCount">
|
|
<summary>Constant SaRequiredSampleCount.</summary>
|
|
<unmanaged>MF_SA_REQUIRED_SAMPLE_COUNT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRAttributeKeys.VideoZoomRect">
|
|
<summary>Constant VideoZoomRect.</summary>
|
|
<unmanaged>VIDEO_ZOOM_RECT</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.EVRConfigAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.EVRConfigAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRConfigAttributeKeys.AllowBatching">
|
|
<summary>Constant AllowBatching.</summary>
|
|
<unmanaged>EVRConfig_AllowBatching</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRConfigAttributeKeys.AllowDropToBob">
|
|
<summary>Constant AllowDropToBob.</summary>
|
|
<unmanaged>EVRConfig_AllowDropToBob</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRConfigAttributeKeys.AllowDropToHalfInterlace">
|
|
<summary>Constant AllowDropToHalfInterlace.</summary>
|
|
<unmanaged>EVRConfig_AllowDropToHalfInterlace</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRConfigAttributeKeys.AllowDropToThrottle">
|
|
<summary>Constant AllowDropToThrottle.</summary>
|
|
<unmanaged>EVRConfig_AllowDropToThrottle</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRConfigAttributeKeys.AllowScaling">
|
|
<summary>Constant AllowScaling.</summary>
|
|
<unmanaged>EVRConfig_AllowScaling</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRConfigAttributeKeys.ForceBatching">
|
|
<summary>Constant ForceBatching.</summary>
|
|
<unmanaged>EVRConfig_ForceBatching</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRConfigAttributeKeys.ForceBob">
|
|
<summary>Constant ForceBob.</summary>
|
|
<unmanaged>EVRConfig_ForceBob</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRConfigAttributeKeys.ForceHalfInterlace">
|
|
<summary>Constant ForceHalfInterlace.</summary>
|
|
<unmanaged>EVRConfig_ForceHalfInterlace</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRConfigAttributeKeys.ForceScaling">
|
|
<summary>Constant ForceScaling.</summary>
|
|
<unmanaged>EVRConfig_ForceScaling</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRConfigAttributeKeys.ForceThrottle">
|
|
<summary>Constant ForceThrottle.</summary>
|
|
<unmanaged>EVRConfig_ForceThrottle</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.MixerActivate">
|
|
<summary>Constant MixerActivate.</summary>
|
|
<unmanaged>MF_ACTIVATE_CUSTOM_VIDEO_MIXER_ACTIVATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.MixerClsid">
|
|
<summary>Constant MixerClsid.</summary>
|
|
<unmanaged>MF_ACTIVATE_CUSTOM_VIDEO_MIXER_CLSID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.MixerFlags">
|
|
<summary>Constant MixerFlags.</summary>
|
|
<unmanaged>MF_ACTIVATE_CUSTOM_VIDEO_MIXER_FLAGS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.PresenterActivate">
|
|
<summary>Constant PresenterActivate.</summary>
|
|
<unmanaged>MF_ACTIVATE_CUSTOM_VIDEO_PRESENTER_ACTIVATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.PresenterClsid">
|
|
<summary>Constant PresenterClsid.</summary>
|
|
<unmanaged>MF_ACTIVATE_CUSTOM_VIDEO_PRESENTER_CLSID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.PresenterFlags">
|
|
<summary>Constant PresenterFlags.</summary>
|
|
<unmanaged>MF_ACTIVATE_CUSTOM_VIDEO_PRESENTER_FLAGS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.ActivateVideoWindow">
|
|
<summary>Constant ActivateVideoWindow.</summary>
|
|
<unmanaged>MF_ACTIVATE_VIDEO_WINDOW</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaFactory">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.MediaFactory']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaFactory.Version">
|
|
<summary>Constant Version.</summary>
|
|
<unmanaged>MF_VERSION</unmanaged>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoSampleFromSurface(SharpDX.ComObject,SharpDX.MediaFoundation.Sample@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates a media sample that manages a Direct3D surface. </p>
|
|
</summary>
|
|
<param name="unkSurfaceRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the Direct3D surface. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="sampleOut"><dd> <p> Receives a reference to the sample's <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The media sample created by this function exposes the following interfaces in addition to <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong>:</p><ul> <li> <strong><see cref="T:SharpDX.MediaFoundation.DesiredSample"/></strong> </li> <li> <strong><see cref="T:SharpDX.MediaFoundation.TrackedSample"/></strong> </li> </ul><p>If <em>pUnkSurface</em> is non-<strong><c>null</c></strong>, the sample contains a single media buffer, which holds a reference to the Direct3D surface. To get the Direct3D surface from the media buffer, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> on the buffer, using the service identifier MR_BUFFER_SERVICE. The media buffer does not implement <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong>, nor does it implement the <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.Lock(System.Byte[],System.Int32@,System.Int32@)"/></strong> and <strong>Unlock</strong> methods.</p><p>Alternatively, you can set <em>pUnkSurface</em> to <strong><c>null</c></strong>, and later add a DirectX surface buffer to the sample by calling <strong><see cref="M:SharpDX.MediaFoundation.Sample.AddBuffer(SharpDX.MediaFoundation.MediaBuffer)"/></strong>. To create a DirectX surface buffer, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateDXSurfaceBuffer(System.Guid,SharpDX.ComObject,System.Boolean,SharpDX.MediaFoundation.MediaBuffer@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoSampleFromSurface']/*"/>
|
|
<msdn-id>ms703859</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoSampleFromSurface([In] IUnknown* pUnkSurface,[Out] IMFSample** ppSample)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoSampleFromSurface</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoPresenter(SharpDX.ComObject,System.Guid,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="ownerRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="riidDevice"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="riid">No documentation.</param>
|
|
<param name="videoPresenterOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoPresenter']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoPresenter([In, Optional] IUnknown* pOwner,[In] const GUID& riidDevice,[In] const GUID& riid,[Out, Optional] void** ppVideoPresenter)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoPresenter</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoMixer(SharpDX.ComObject,System.Guid,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="ownerRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="riidDevice"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="riid">No documentation.</param>
|
|
<param name="vOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoMixer']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoMixer([In, Optional] IUnknown* pOwner,[In] const GUID& riidDevice,[In] const GUID& riid,[Out] void** ppv)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoMixer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoSampleAllocator(System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates an object that allocates video samples.</p>
|
|
</summary>
|
|
<param name="riid"><dd> <p>The identifier of the interface to retrieve. Specify one of the following values:</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><strong>IID_IUnknown</strong></strong></dt> </dl> </td><td> <p>Retrieve an <strong><see cref="T:SharpDX.ComObject"/></strong> reference.</p> </td></tr> <tr><td><dl> <dt><strong><strong>IID_IMFVideoSampleAllocator</strong></strong></dt> </dl> </td><td> <p>Retrieve an <strong><see cref="T:SharpDX.MediaFoundation.VideoSampleAllocator"/></strong> reference.</p> </td></tr> <tr><td><dl> <dt><strong><strong>IID_IMFVideoSampleAllocatorCallback</strong></strong></dt> </dl> </td><td> <p>Retrieve an <strong><see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorCallback"/></strong> reference.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="sampleAllocatorOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If the function succeeds, it returns <see cref="F:SharpDX.Result.Ok"/>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoSampleAllocator']/*"/>
|
|
<msdn-id>ff384864</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoSampleAllocator([In] const GUID& riid,[Out] void** ppSampleAllocator)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoSampleAllocator</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoRenderer(System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates an instance of the enhanced video renderer (EVR) media sink.</p>
|
|
</summary>
|
|
<param name="riidRenderer"><dd> <p>Interface identifier (IID) of the requested interface on the EVR.</p> </dd></param>
|
|
<param name="videoRendererOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This function creates the Media Foundation version of the EVR. To create the DirectShow EVR filter, call <strong>CoCreateInstance</strong> with the class identifier CLSID_EnhancedVideoRenderer.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoRenderer']/*"/>
|
|
<msdn-id>ms703814</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoRenderer([In] const GUID& riidRenderer,[Out, Optional] void** ppVideoRenderer)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoRenderer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoMixerAndPresenter(SharpDX.ComObject,SharpDX.ComObject,System.Guid,System.IntPtr@,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates the default video mixer and video presenter for the enhanced video renderer (EVR).</p>
|
|
</summary>
|
|
<param name="mixerOwnerRef"><dd> <p>Pointer to the owner of the video mixer. If the mixer is aggregated, pass a reference to the aggregating object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. Otherwise, set this parameter to <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="presenterOwnerRef"><dd> <p>Pointer to the owner of the video presenter. If the presenter is aggregated, pass a reference to the aggregating object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. Otherwise, set this parameter to <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="riidMixer"><dd> <p>Interface identifier (IID) of the requested interface on the video mixer. The video mixer exposes the <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> interface.</p> </dd></param>
|
|
<param name="vVideoMixerOut"><dd> <p>Receives a reference to the requested interface on the video mixer. The caller must release the interface.</p> </dd></param>
|
|
<param name="riidPresenter"><dd> <p>IID of the requested interface on the video presenter. The video presenter exposes the <strong><see cref="T:SharpDX.MediaFoundation.VideoPresenter"/></strong> interface.</p> </dd></param>
|
|
<param name="vVideoPresenterOut"><dd> <p>Receives a reference to the requested interface on the video presenter. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoMixerAndPresenter']/*"/>
|
|
<msdn-id>ms694842</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoMixerAndPresenter([In, Optional] IUnknown* pMixerOwner,[In, Optional] IUnknown* pPresenterOwner,[In] const GUID& riidMixer,[Out] void** ppvVideoMixer,[In] const GUID& riidPresenter,[Out] void** ppvVideoPresenter)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoMixerAndPresenter</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="version"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="dwFlags"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFStartup']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFStartup([In] unsigned int Version,[In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>MFStartup</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaExtensionActivate(System.String,SharpDX.ComObject,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates an activation object for a Windows Runtime class.</p>
|
|
</summary>
|
|
<param name="szActivatableClassId"><dd> <p>The class identifier that is associated with the activatable runtime class.</p> </dd></param>
|
|
<param name="configurationRef"><dd> <p>An optional friendly name for the activation object. The friendly name is stored in the object's <see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftFriendlyNameAttribute"/> attribute. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="riid"><dd> <p>A reference to an optional <strong>IPropertySet</strong> object, which is used to configure the Windows Runtime class. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="vObjectOut"><dd> <p>The interface identifier (IID) of the interface being requested. The activation object created by this function supports the following interfaces:</p> <ul> <li> <strong><see cref="T:SharpDX.ComObject"/></strong> </li> <li> <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> </li> <li> <strong>IPersistStream</strong> </li> </ul> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To create the Windows Runtime object, call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> or <strong>IClassFactory::CreateInstance</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMediaExtensionActivate']/*"/>
|
|
<msdn-id>hh162753</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMediaExtensionActivate([In] const wchar_t* szActivatableClassId,[In, Optional] IUnknown* pConfiguration,[In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
|
|
<unmanaged-short>MFCreateMediaExtensionActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.TUnregisterLocalByCLSID(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Unregisters a Media Foundation transform (MFT) from the caller's process.</p>
|
|
</summary>
|
|
<param name="clsidMFT"><dd> <p>The class identifier (CLSID) of the MFT.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>HRESULT_FROM_WIN32(<strong><see cref="F:SharpDX.Win32.ErrorCode.NotFound"/></strong>)</strong></dt> </dl> </td><td> <p>The MFT specified by the <em>clsidMFT</em> parameter was not registered in this process.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Use this function to unregister a local MFT that was previously registered through the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocalByCLSID(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTUnregisterLocalByCLSID']/*"/>
|
|
<msdn-id>dd388659</msdn-id>
|
|
<unmanaged>HRESULT MFTUnregisterLocalByCLSID([In] GUID clsidMFT)</unmanaged>
|
|
<unmanaged-short>MFTUnregisterLocalByCLSID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.AddPeriodicCallback(SharpDX.FunctionCallback,SharpDX.ComObject,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Cancels a callback function that was set by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AddPeriodicCallback(SharpDX.FunctionCallback,SharpDX.ComObject,System.Int32@)"/></strong> function.</p>
|
|
</summary>
|
|
<param name="callback">No documentation.</param>
|
|
<param name="contextRef">No documentation.</param>
|
|
<param name="dwKeyRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The callback is dispatched on another thread, and this function does not attempt to synchronize with the callback thread. Therefore, it is possible for the callback to be invoked after this function returns.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAddPeriodicCallback']/*"/>
|
|
<msdn-id>ms704741</msdn-id>
|
|
<unmanaged>HRESULT MFAddPeriodicCallback([In] __function__stdcall* Callback,[In] IUnknown* pContext,[Out, Optional] unsigned int* pdwKey)</unmanaged>
|
|
<unmanaged-short>MFAddPeriodicCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetWorkQueueMMCSSPriority(System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Gets the relative thread priority of a work queue.</p>
|
|
</summary>
|
|
<param name="dwWorkQueueId"><dd> <p>The identifier of the work queue. For private work queues, the identifier is returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> function. For platform work queues, see <strong>Work Queue Identifiers</strong>.</p> </dd></param>
|
|
<param name="lPriority"><dd> <p>Receives the relative thread priority.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function returns the relative thread priority set by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.BeginRegisterWorkQueueWithMMCSSEx(System.Int32,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetWorkQueueMMCSSPriority']/*"/>
|
|
<msdn-id>hh162768</msdn-id>
|
|
<unmanaged>HRESULT MFGetWorkQueueMMCSSPriority([In] unsigned int dwWorkQueueId,[Out] int* lPriority)</unmanaged>
|
|
<unmanaged-short>MFGetWorkQueueMMCSSPriority</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateAudioMediaType(SharpDX.Multimedia.WaveFormat@,SharpDX.MediaFoundation.AudioMediaType@)">
|
|
<summary>
|
|
<p>[This API is not supported and may be altered or unavailable in the future.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Creates an audio media type from a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure.</p>
|
|
</summary>
|
|
<param name="audioFormatRef"><dd> <p>Pointer to a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure that describes the audio format.</p> </dd></param>
|
|
<param name="iAudioMediaTypeOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.AudioMediaType"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> The <strong><see cref="T:SharpDX.MediaFoundation.AudioMediaType"/></strong> interface is deprecrated, so applications should avoid using this function. To create a media type from a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure, do the following: </p><ol> <li> Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaType(SharpDX.MediaFoundation.MediaType@)"/></strong>. This function returns a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. The returned media type object is initially empty. </li> <li> Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.InitMediaTypeFromWaveFormatEx(SharpDX.MediaFoundation.MediaType,SharpDX.Multimedia.WaveFormat[],System.Int32)"/></strong> to populate the media type from the <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure. </li> </ol><p> Alternatively, you can call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaType(SharpDX.MediaFoundation.MediaType@)"/></strong> and then set the media type attributes directly. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateAudioMediaType']/*"/>
|
|
<msdn-id>aa473812</msdn-id>
|
|
<unmanaged>HRESULT MFCreateAudioMediaType([In] const WAVEFORMATEX* pAudioFormat,[Out] IMFAudioMediaType** ppIAudioMediaType)</unmanaged>
|
|
<unmanaged-short>MFCreateAudioMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CancelCreateFile(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Begins an asynchronous request to create a byte stream from a file.</p>
|
|
</summary>
|
|
<param name="cancelCookieRef"><dd> <p>The requested access mode, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileAccessmode"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When the request is completed, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. The callback object should then call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.EndCreateFile(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ByteStream@)"/></strong> function to get a reference to the byte stream.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCancelCreateFile']/*"/>
|
|
<msdn-id>ms702074</msdn-id>
|
|
<unmanaged>HRESULT MFCancelCreateFile([In] IUnknown* pCancelCookie)</unmanaged>
|
|
<unmanaged-short>MFCancelCreateFile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.FrameRateToAverageTimePerFrame(System.Int32,System.Int32,System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Converts a video frame rate into a frame duration.</p>
|
|
</summary>
|
|
<param name="unNumerator"><dd> <p>The numerator of the frame rate. </p> </dd></param>
|
|
<param name="unDenominator"><dd> <p> The denominator of the frame rate. </p> </dd></param>
|
|
<param name="unAverageTimePerFrameRef"><dd> <p> Receives the average duration of a video frame, in 100-nanosecond units. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function is useful for calculating time stamps on a sample, given the frame rate.</p><p>Also, average time per frame is used in the older <strong><see cref="!:SharpDX.Win32.Unsupported.VideoInfoHeader"/></strong> and <strong><see cref="!:SharpDX.MediaFoundation.VideoInformationHeader2"/></strong> format structures. This function provides a standard conversion so that all components in the pipeline can use consistent values, if they need to translate between the older format structures and the media type attributes used in Media Foundation.</p><p> For certain common frame rates, the function gets the frame duration from a look-up table:</p><table> <tr><th>Frames per second (floating point)</th><th>Frames per second (fractional)</th><th>Average time per frame</th></tr> <tr><td>59.94</td><td>60000/1001</td><td>166833</td></tr> <tr><td>29.97</td><td>30000/1001</td><td>333667</td></tr> <tr><td>23.976</td><td>24000/1001</td><td>417188</td></tr> <tr><td>60</td><td>60/1</td><td>166667</td></tr> <tr><td>30</td><td>30/1</td><td>333333</td></tr> <tr><td>50</td><td>50/1</td><td>200000</td></tr> <tr><td>25</td><td>25/1</td><td>400000</td></tr> <tr><td>24</td><td>24/1</td><td>416667</td></tr> </table><p>?</p><p> Most video content uses one of the frame rates listed here. For other frame rates, the function calculates the duration.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFFrameRateToAverageTimePerFrame']/*"/>
|
|
<msdn-id>aa370467</msdn-id>
|
|
<unmanaged>HRESULT MFFrameRateToAverageTimePerFrame([In] unsigned int unNumerator,[In] unsigned int unDenominator,[Out] unsigned longlong* punAverageTimePerFrame)</unmanaged>
|
|
<unmanaged-short>MFFrameRateToAverageTimePerFrame</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.BeginRegisterWorkQueueWithMMCSSEx(System.Int32,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p> Associates a work queue with a Multimedia Class Scheduler Service (MMCSS) task.</p>
|
|
</summary>
|
|
<param name="dwWorkQueueId"><dd> <p>The identifier of the work queue. For private work queues, the identifier is returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> function. For platform work queues, see <strong>Work Queue Identifiers</strong>.</p> </dd></param>
|
|
<param name="wszClass"><dd> <p> The name of the MMCSS task. For more information, see Multimedia Class Scheduler Service. </p> </dd></param>
|
|
<param name="dwTaskId"><dd> <p>The unique task identifier. To obtain a new task identifier, set this value to zero. </p> </dd></param>
|
|
<param name="lPriority"><dd> <p>The base relative priority for the work-queue threads. For more information, see <strong>AvSetMmThreadPriority</strong>.</p> </dd></param>
|
|
<param name="doneCallbackRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface. </p> </dd></param>
|
|
<param name="doneStateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function extends the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.BeginRegisterWorkQueueWithMMCSS(System.Int32,System.String,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> function by adding the <em>lPriority</em> parameter.</p><p>This function is asynchronous. When the operation completes, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.EndRegisterWorkQueueWithMMCSS(SharpDX.MediaFoundation.AsyncResult,System.Int32@)"/></strong> to complete the asynchronous request. </p><p>To unregister the work queue from the MMCSS task, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.BeginUnregisterWorkQueueWithMMCSS(System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBeginRegisterWorkQueueWithMMCSSEx']/*"/>
|
|
<msdn-id>hh162745</msdn-id>
|
|
<unmanaged>HRESULT MFBeginRegisterWorkQueueWithMMCSSEx([In] unsigned int dwWorkQueueId,[In] const wchar_t* wszClass,[In] unsigned int dwTaskId,[In] int lPriority,[In] IMFAsyncCallback* pDoneCallback,[In] IUnknown* pDoneState)</unmanaged>
|
|
<unmanaged-short>MFBeginRegisterWorkQueueWithMMCSSEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoMediaTypeFromBitMapInfoHeader(SharpDX.Win32.BitmapInfoHeader@,System.Int32,System.Int32,SharpDX.MediaFoundation.VideoInterlaceMode,System.Int64,System.Int64,System.Int64,System.Int32,SharpDX.MediaFoundation.VideoMediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> This function is not implemented.</p>
|
|
</summary>
|
|
<param name="bmihBitMapInfoHeaderRef"><dd> <p>Reserved.</p> </dd></param>
|
|
<param name="dwPixelAspectRatioX"><dd> <p>Reserved.</p> </dd></param>
|
|
<param name="dwPixelAspectRatioY"><dd> <p>Reserved.</p> </dd></param>
|
|
<param name="interlaceMode"><dd> <p>Reserved.</p> </dd></param>
|
|
<param name="videoFlags"><dd> <p>Reserved.</p> </dd></param>
|
|
<param name="qwFramesPerSecondNumerator"><dd> <p>Reserved.</p> </dd></param>
|
|
<param name="qwFramesPerSecondDenominator"><dd> <p>Reserved.</p> </dd></param>
|
|
<param name="dwMaxBitRate"><dd> <p>Reserved.</p> </dd></param>
|
|
<param name="iVideoMediaTypeOut"><dd> <p>Reserved.</p> </dd></param>
|
|
<returns><p>Returns <strong>E_FAIL</strong>.</p></returns>
|
|
<remarks>
|
|
<p><strong>Note</strong>??Prior to Windows?7, this function was exported from evr.dll. Starting in Windows?7, this function is exported from mfplat.dll, and evr.dll exports a stub function that calls into mfplat.dll. For more information, see Library Changes in Windows?7.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoMediaTypeFromBitMapInfoHeader']/*"/>
|
|
<msdn-id>aa473801</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoMediaTypeFromBitMapInfoHeader([In] const BITMAPINFOHEADER* pbmihBitMapInfoHeader,[In] unsigned int dwPixelAspectRatioX,[In] unsigned int dwPixelAspectRatioY,[In] MFVideoInterlaceMode InterlaceMode,[In] unsigned longlong VideoFlags,[In] unsigned longlong qwFramesPerSecondNumerator,[In] unsigned longlong qwFramesPerSecondDenominator,[In] unsigned int dwMaxBitRate,[Out] IMFVideoMediaType** ppIVideoMediaType)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoMediaTypeFromBitMapInfoHeader</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoMediaType(SharpDX.MediaFoundation.Videoformat@,SharpDX.MediaFoundation.VideoMediaType@)">
|
|
<summary>
|
|
<p>[This API is not supported and may be altered or unavailable in the future. Applications should avoid using the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure, and use media type attributes instead. For more information, see Video Media Types.]</p><p><strong>Applies to: </strong>desktop apps only</p><p> Creates a video media type from an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure. </p>
|
|
</summary>
|
|
<param name="videoFormatRef">No documentation.</param>
|
|
<param name="iVideoMediaTypeOut">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> Instead of using the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure to initialize a video media type, you can call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaType(SharpDX.MediaFoundation.MediaType@)"/></strong> and set the media type attributes directly. </p><p><strong>Note</strong>??Prior to Windows?7, this function was exported from evr.dll. Starting in Windows?7, this function is exported from mfplat.dll, and evr.dll exports a stub function that calls into mfplat.dll. For more information, see Library Changes in Windows?7.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoMediaType']/*"/>
|
|
<msdn-id>aa473781</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoMediaType([In] const MFVIDEOFORMAT* pVideoFormat,[Out] IMFVideoMediaType** ppIVideoMediaType)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.InvokeCallback(SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Invokes a callback method to complete an asynchronous operation. </p>
|
|
</summary>
|
|
<param name="asyncResultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. To create this object, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong>.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p> The function succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALID_WORKQUEUE</strong></strong></dt> </dl> </td><td> <p>Invalid work queue. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.GetParameters(System.Int32@,System.Int32@)"/></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> function was called to shut down the Media Foundation platform.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If you are implementing an asynchronous method, use this function to invoke the caller's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p><p>The callback is invoked from a Media Foundation work queue. For more information, see Writing an Asynchronous Method.</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> function shuts down the work queue threads, so the callback is not guaranteed to be invoked after <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> is called.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFInvokeCallback']/*"/>
|
|
<msdn-id>ms695400</msdn-id>
|
|
<unmanaged>HRESULT MFInvokeCallback([In] IMFAsyncResult* pAsyncResult)</unmanaged>
|
|
<unmanaged-short>MFInvokeCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CancelWorkItem(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Attempts to cancel an asynchronous operation that was scheduled with <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.ScheduleWorkItem(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,System.Int64,System.Int64@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.ScheduleWorkItemEx(SharpDX.MediaFoundation.AsyncResult,System.Int64,System.Int64@)"/></strong>.</p>
|
|
</summary>
|
|
<param name="key">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Because work items are asynchronous, the work-item callback might still be invoked after <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CancelWorkItem(System.Int64)"/></strong> is called.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCancelWorkItem']/*"/>
|
|
<msdn-id>ms701633</msdn-id>
|
|
<unmanaged>HRESULT MFCancelWorkItem([In] unsigned longlong Key)</unmanaged>
|
|
<unmanaged-short>MFCancelWorkItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.ConvertFromFP16Array(System.Single[],System.Int16[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="destRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="srcRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="dwCount">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFConvertFromFP16Array']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFConvertFromFP16Array([Out, Buffer] float* pDest,[In, Buffer] const unsigned short* pSrc,[In] unsigned int dwCount)</unmanaged>
|
|
<unmanaged-short>MFConvertFromFP16Array</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.TRegister(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],SharpDX.MediaFoundation.MediaAttributes)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Adds information about a Media Foundation transform (MFT) to the registry. </p><p>Applications can enumerate the MFT by calling the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnum(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.MediaAttributes,System.Guid[],System.Int32@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> function.</p>
|
|
</summary>
|
|
<param name="clsidMFT">No documentation.</param>
|
|
<param name="guidCategory">No documentation.</param>
|
|
<param name="szNameRef">No documentation.</param>
|
|
<param name="flags">No documentation.</param>
|
|
<param name="cInputTypes">No documentation.</param>
|
|
<param name="inputTypesRef">No documentation.</param>
|
|
<param name="cOutputTypes">No documentation.</param>
|
|
<param name="outputTypesRef">No documentation.</param>
|
|
<param name="attributesRef">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> The registry entries created by this function are read by the following functions: </p><table> <tr><th>Function</th><th>Description</th></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnum(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.MediaAttributes,System.Guid[],System.Int32@)"/></strong> </td><td>Enumerates MFTs by media type and category.</td></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> </td><td>Extended version of <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnum(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.MediaAttributes,System.Guid[],System.Int32@)"/></strong>.</td></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TGetInfo(System.Guid,System.IntPtr,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32@,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32@,SharpDX.MediaFoundation.MediaAttributes@)"/></strong> </td><td>Looks up an MFT by CLSID and retrieves the registry information.</td></tr> </table><p>?</p><p>This function does not register the CLSID of the MFT for the <strong>CoCreateInstance</strong> or <strong>CoGetClassObject</strong> functions. </p><p> To remove the entries from the registry, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TUnregister(System.Guid)"/></strong>. If you remove an MFT from the system, you should always call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TUnregister(System.Guid)"/></strong>.</p><p> The formats given in the <em>pInputTypes</em> and <em>pOutputTypes</em> parameters are intended to help applications search for MFTs by format. Applications can use the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnum(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.MediaAttributes,System.Guid[],System.Int32@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> functions to enumerate MFTs that match a particular set of formats.</p><p>It is recommended to specify at least one input type in <em>pInputTypes</em> and one output type in the <em>pOutputTypes</em> parameter. Otherwise, the MFT might be skipped in the enumeration.</p><p>On 64-bit Windows, the 32-bit version of this function registers the MFT in the 32-bit node of the registry. For more information, see 32-bit and 64-bit Application Data in the Registry.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTRegister']/*"/>
|
|
<msdn-id>ms705640</msdn-id>
|
|
<unmanaged>HRESULT MFTRegister([In] GUID clsidMFT,[In] GUID guidCategory,[In] wchar_t* pszName,[In] unsigned int Flags,[In] unsigned int cInputTypes,[In, Buffer, Optional] MFT_REGISTER_TYPE_INFO* pInputTypes,[In] unsigned int cOutputTypes,[In, Buffer, Optional] MFT_REGISTER_TYPE_INFO* pOutputTypes,[In, Optional] IMFAttributes* pAttributes)</unmanaged>
|
|
<unmanaged-short>MFTRegister</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateAttributes(SharpDX.MediaFoundation.MediaAttributes,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates an empty attribute store. </p>
|
|
</summary>
|
|
<param name="mFAttributesOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<param name="cInitialSize"><dd> <p>The initial number of elements allocated for the attribute store. The attribute store grows as needed. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Attributes are used throughout Microsoft Media Foundation to configure objects, describe media formats, query object properties, and other purposes. For more information, see Attributes in Media Foundation.</p><p>For a complete list of all the defined attribute GUIDs in Media Foundation, see Media Foundation Attributes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateAttributes']/*"/>
|
|
<msdn-id>ms701878</msdn-id>
|
|
<unmanaged>HRESULT MFCreateAttributes([Out, Fast] IMFAttributes** ppMFAttributes,[In] unsigned int cInitialSize)</unmanaged>
|
|
<unmanaged-short>MFCreateAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateWaveFormatExFromMFMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.Multimedia.WaveFormat@,System.Int32@,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Converts a Media Foundation audio media type to a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure.</p>
|
|
</summary>
|
|
<param name="mFTypeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type.</p> </dd></param>
|
|
<param name="wFOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure. The caller must release the memory allocated for the structure by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbSizeRef"><dd> <p>Receives the size of the <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure.</p> </dd></param>
|
|
<param name="flags"><dd> <p>Contains a flag from the <strong><see cref="T:SharpDX.MediaFoundation.WaveFormatExConvertFlags"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the <strong>wFormatTag</strong> member of the returned structure is <strong><see cref="F:SharpDX.Multimedia.WaveFormatEncoding.Extensible"/></strong>, you can cast the reference to a <strong><see cref="T:SharpDX.Multimedia.WaveFormatExtensible"/></strong> structure.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateWaveFormatExFromMFMediaType']/*"/>
|
|
<msdn-id>ms702177</msdn-id>
|
|
<unmanaged>HRESULT MFCreateWaveFormatExFromMFMediaType([In] IMFMediaType* pMFType,[Out] WAVEFORMATEX** ppWF,[Out, Optional] unsigned int* pcbSize,[In] unsigned int Flags)</unmanaged>
|
|
<unmanaged-short>MFCreateWaveFormatExFromMFMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetUncompressedVideoFormat(SharpDX.MediaFoundation.Videoformat@)">
|
|
<summary>
|
|
<p>[This API is not supported and may be altered or unavailable in the future. Applications should avoid using the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure, and use media type attributes instead. For more information, see Video Media Types.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Returns the FOURCC or <strong>D3DFORMAT</strong> value for an uncompressed video format.</p>
|
|
</summary>
|
|
<param name="videoFormatRef">No documentation.</param>
|
|
<returns><p>Returns a FOURCC or <strong>D3DFORMAT</strong> value that identifies the video format. If the video format is compressed or not recognized, the return value is D3DFMT_UNKNOWN.</p></returns>
|
|
<remarks>
|
|
<p><strong>Note</strong>??Prior to Windows?7, this function was exported from evr.dll. Starting in Windows?7, this function is exported from mfplat.dll, and evr.dll exports a stub function that calls into mfplat.dll. For more information, see Library Changes in Windows?7.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetUncompressedVideoFormat']/*"/>
|
|
<msdn-id>aa473806</msdn-id>
|
|
<unmanaged>unsigned int MFGetUncompressedVideoFormat([In] const MFVIDEOFORMAT* pVideoFormat)</unmanaged>
|
|
<unmanaged-short>MFGetUncompressedVideoFormat</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocalByCLSID(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Registers a Media Foundation transform (MFT) in the caller's process.</p>
|
|
</summary>
|
|
<param name="clisdMFT"><dd> <p>The class identifier (CLSID) of the MFT.</p> </dd></param>
|
|
<param name="guidCategory"><dd> <p>A <see cref="T:System.Guid"/> that specifies the category of the MFT. For a list of MFT categories, see <strong>MFT_CATEGORY</strong>.</p> </dd></param>
|
|
<param name="szNameRef"><dd> <p>A wide-character null-terminated string that contains the friendly name of the MFT.</p> </dd></param>
|
|
<param name="flags"><dd> <p>A bitwise <strong>OR</strong> of zero or more flags from the <strong>_MFT_ENUM_FLAG</strong> enumeration.</p> </dd></param>
|
|
<param name="cInputTypes"><dd> <p>The number of elements in the <em>pInputTypes</em> array.</p> </dd></param>
|
|
<param name="inputTypesRef"><dd> <p>A reference to an array of <strong><see cref="T:SharpDX.MediaFoundation.TRegisterTypeInformation"/></strong> structures. Each member of the array specifies an input format that the MFT supports. This parameter can be <strong><c>null</c></strong> if <em>cInputTypes</em> is zero.</p> </dd></param>
|
|
<param name="cOutputTypes"><dd> <p>The number of elements in the <em>pOutputTypes</em> array.</p> </dd></param>
|
|
<param name="outputTypesRef"><dd> <p>A reference to an array of <strong><see cref="T:SharpDX.MediaFoundation.TRegisterTypeInformation"/></strong> structures. Each member of the array defines an output format that the MFT supports. This parameter can be <strong><c>null</c></strong> if <em>cOutputTypes</em> is zero.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The primary purpose of this function is to make an MFT available for automatic topology resolution without making the MFT available to other processes or applications.</p><p>After you call this function, the MFT can be enumerated by calling the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> function with the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsLocalmft"/></strong> flag. The MFT can be enumerated from within the same process, but is not visible to other processes.</p><p>To unregister the MFT from the current process, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TUnregisterLocalByCLSID(System.Guid)"/></strong>.</p><p>If you need to register an MFT in the Protected Media Path (PMP) process, use the <strong><see cref="T:SharpDX.MediaFoundation.LocalMFTRegistration"/></strong> interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTRegisterLocalByCLSID']/*"/>
|
|
<msdn-id>dd388657</msdn-id>
|
|
<unmanaged>HRESULT MFTRegisterLocalByCLSID([In] const GUID& clisdMFT,[In] const GUID& guidCategory,[In] const wchar_t* pszName,[In] unsigned int Flags,[In] unsigned int cInputTypes,[In, Buffer, Optional] const MFT_REGISTER_TYPE_INFO* pInputTypes,[In] unsigned int cOutputTypes,[In, Buffer, Optional] const MFT_REGISTER_TYPE_INFO* pOutputTypes)</unmanaged>
|
|
<unmanaged-short>MFTRegisterLocalByCLSID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.PutWaitingWorkItem(System.IntPtr,System.Int32,SharpDX.MediaFoundation.AsyncResult,System.Int64@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Queues a work item that waits for an event to be signaled.</p>
|
|
</summary>
|
|
<param name="hEvent"><dd> <p>A handle to an event object. To create an event object, call <strong>CreateEvent</strong> or <strong>CreateEventEx</strong>.</p> </dd></param>
|
|
<param name="priority"><dd> <p>The priority of the work item. Work items are performed in order of priority.</p> </dd></param>
|
|
<param name="resultRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface of an asynchronous result object. To create the result object, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong>.</p> </dd></param>
|
|
<param name="keyRef"><dd> <p>Receives a key that can be used to cancel the wait. To cancel the wait, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CancelWorkItem(System.Int64)"/></strong> and pass this key in the <em>Key</em> parameter. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function enables a component to wait for an event without blocking the current thread. </p><p>The function puts a work item on the specified work queue. This work item waits for the event given in <em>hEvent</em> to be signaled. When the event is signaled, the work item invokes a callback. (The callback is contained in the result object given in <em>pResult</em>. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong>).</p><p>The work item is dispatched on a work queue by the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.GetParameters(System.Int32@,System.Int32@)"/></strong> method of the callback. The work queue can be any of the following:</p><ul> <li>The default work queue (<strong>MFASYNC_CALLBACK_QUEUE_STANDARD</strong>).</li> <li>The platform multithreaded queue (<strong>MFASYNC_CALLBACK_QUEUE_MULTITHREADED</strong>).</li> <li>A multithreaded queue returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockSharedWorkQueue(System.String,System.Int32,System.Int32@,System.Int32@)"/></strong> function.</li> <li>A serial queue created by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateSerialWorkQueue(System.Int32,System.Int32@)"/></strong> function.</li> </ul><p>Do not use any of the following work queues: <strong>MFASYNC_CALLBACK_QUEUE_IO</strong>, <strong>MFASYNC_CALLBACK_QUEUE_LONG_FUNCTION</strong>, <strong>MFASYNC_CALLBACK_QUEUE_RT</strong>, or <strong>MFASYNC_CALLBACK_QUEUE_TIMER</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPutWaitingWorkItem']/*"/>
|
|
<msdn-id>hh162783</msdn-id>
|
|
<unmanaged>HRESULT MFPutWaitingWorkItem([In] void* hEvent,[In] int Priority,[In] IMFAsyncResult* pResult,[Out, Optional] unsigned longlong* pKey)</unmanaged>
|
|
<unmanaged-short>MFPutWaitingWorkItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItemEx(System.Int32,SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Puts an asynchronous operation on a work queue. </p>
|
|
</summary>
|
|
<param name="dwQueue"><dd> <p>The identifier for the work queue. This value can specify one of the standard Media Foundation work queues, or a work queue created by the application. For list of standard Media Foundation work queues, see <strong>Work Queue Identifiers</strong>. To create a new work queue, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueueEx(SharpDX.MediaFoundation.AsyncWorkqueueType,System.Int32@)"/></strong>. </p> </dd></param>
|
|
<param name="resultRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface of an asynchronous result object. To create the result object, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong>. </p> </dd></param>
|
|
<returns><p> Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include the following.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p> Success.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALID_WORKQUEUE</strong></strong></dt> </dl> </td><td> <p>Invalid work queue identifier. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.GetParameters(System.Int32@,System.Int32@)"/></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> function was not called, or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> To invoke the work-item, this function passes <em>pResult</em> to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.InvokeCallback(SharpDX.MediaFoundation.AsyncResult)"/></strong> function. The callback is specified when you create the result object specified by <em>pResult</em>. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPutWorkItemEx']/*"/>
|
|
<msdn-id>ms697572</msdn-id>
|
|
<unmanaged>HRESULT MFPutWorkItemEx([In] unsigned int dwQueue,[In] IMFAsyncResult* pResult)</unmanaged>
|
|
<unmanaged-short>MFPutWorkItemEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMFVideoFormatFromMFMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.Videoformat@,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="mFTypeRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="mFVFOut"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="cbSizeRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMFVideoFormatFromMFMediaType']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMFVideoFormatFromMFMediaType([In] IMFMediaType* pMFType,[Out] MFVIDEOFORMAT** ppMFVF,[Out, Optional] unsigned int* pcbSize)</unmanaged>
|
|
<unmanaged-short>MFCreateMFVideoFormatFromMFMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.RegisterPlatformWithMMCSS(System.String,System.Int32@,System.Int32)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Registers the standard Microsoft Media Foundation platform work queues with the Multimedia Class Scheduler Service (MMCSS).
|
|
</p>
|
|
</summary>
|
|
<param name="wszClass"><dd> <p>The name of the MMCSS task. </p> </dd></param>
|
|
<param name="dwTaskIdRef"><dd> <p>The MMCSS task identifier. On input, specify an existing MCCSS task group ID, or use the value zero to create a new task group. On output, receives the actual task group ID.</p> </dd></param>
|
|
<param name="lPriority"><dd> <p>The base priority of the work-queue threads. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To unregister the platform work queues from the MMCSS class, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnregisterPlatformFromMMCSS"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRegisterPlatformWithMMCSS']/*"/>
|
|
<msdn-id>hh162788</msdn-id>
|
|
<unmanaged>HRESULT MFRegisterPlatformWithMMCSS([In] const wchar_t* wszClass,[InOut] unsigned int* pdwTaskId,[In] int lPriority)</unmanaged>
|
|
<unmanaged-short>MFRegisterPlatformWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.TEnum(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.MediaAttributes,System.Guid[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Enumerates Media Foundation transforms (MFTs) in the registry. </p><p>Starting in Windows?7, applications should use the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> function instead.</p>
|
|
</summary>
|
|
<param name="guidCategory">No documentation.</param>
|
|
<param name="flags">No documentation.</param>
|
|
<param name="inputTypeRef">No documentation.</param>
|
|
<param name="outputTypeRef">No documentation.</param>
|
|
<param name="attributesRef">No documentation.</param>
|
|
<param name="clsidMFTOut">No documentation.</param>
|
|
<param name="cMFTsRef">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This function returns a list of all the MFTs in the specified category that match the search criteria given by the <em>pInputType</em>, <em>pOutputType</em>, and <em>pAttributes</em> parameters. Any of those parameters can be <strong><c>null</c></strong>. </p><p> If no MFTs match the criteria, the method succeeds but returns the value zero in <em>pcMFTs</em>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTEnum']/*"/>
|
|
<msdn-id>ms701774</msdn-id>
|
|
<unmanaged>HRESULT MFTEnum([In] GUID guidCategory,[In] unsigned int Flags,[In, Optional] MFT_REGISTER_TYPE_INFO* pInputType,[In, Optional] MFT_REGISTER_TYPE_INFO* pOutputType,[In, Optional] IMFAttributes* pAttributes,[Out, Buffer] GUID** ppclsidMFT,[Out] unsigned int* pcMFTs)</unmanaged>
|
|
<unmanaged-short>MFTEnum</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.EndRegisterWorkQueueWithMMCSS(SharpDX.MediaFoundation.AsyncResult,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="dwTaskIdRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFEndRegisterWorkQueueWithMMCSS']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFEndRegisterWorkQueueWithMMCSS([In] IMFAsyncResult* pResult,[Out] unsigned int* pdwTaskId)</unmanaged>
|
|
<unmanaged-short>MFEndRegisterWorkQueueWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CompareFullToPartialMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates the source resolver, which is used to create a media source from a URL or byte stream. </p>
|
|
</summary>
|
|
<param name="mFTypeFullRef"><dd> <p>Receives a reference to the source resolver's <strong><see cref="T:SharpDX.MediaFoundation.SourceResolver"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<param name="mFTypePartialRef">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p><strong>Note</strong>??Prior to Windows?7, this function was exported from mf.dll. Starting in Windows?7, this function is exported from mfplat.dll, and mf.dll exports a stub function that calls into mfplat.dll. For more information, see Library Changes in Windows?7.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCompareFullToPartialMediaType']/*"/>
|
|
<msdn-id>ms697433</msdn-id>
|
|
<unmanaged>BOOL MFCompareFullToPartialMediaType([In] IMFMediaType* pMFTypeFull,[In] IMFMediaType* pMFTypePartial)</unmanaged>
|
|
<unmanaged-short>MFCompareFullToPartialMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetAttributesAsBlob(SharpDX.MediaFoundation.MediaAttributes,System.Byte[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the size of the buffer needed for the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.GetAttributesAsBlob(SharpDX.MediaFoundation.MediaAttributes,System.Byte[],System.Int32)"/></strong> function.</p>
|
|
</summary>
|
|
<param name="attributesRef">No documentation.</param>
|
|
<param name="bufRef">No documentation.</param>
|
|
<param name="cbBufSize">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Use this function to find the size of the array that is needed for the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.GetAttributesAsBlob(SharpDX.MediaFoundation.MediaAttributes,System.Byte[],System.Int32)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetAttributesAsBlob']/*"/>
|
|
<msdn-id>ms697064</msdn-id>
|
|
<unmanaged>HRESULT MFGetAttributesAsBlob([In] IMFAttributes* pAttributes,[Out, Buffer] unsigned char* pBuf,[In] unsigned int cbBufSize)</unmanaged>
|
|
<unmanaged-short>MFGetAttributesAsBlob</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CopyImage(System.Byte[],System.Int32,System.Byte[],System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Copies an image or image plane from one buffer to another. </p>
|
|
</summary>
|
|
<param name="destRef"><dd> <p> Pointer to the start of the first row of pixels in the destination buffer. </p> </dd></param>
|
|
<param name="lDestStride"><dd> <p> Stride of the destination buffer, in bytes. </p> </dd></param>
|
|
<param name="srcRef"><dd> <p> Pointer to the start of the first row of pixels in the source image. </p> </dd></param>
|
|
<param name="lSrcStride"><dd> <p> Stride of the source image, in bytes. </p> </dd></param>
|
|
<param name="dwWidthInBytes"><dd> <p> Width of the image, in bytes. </p> </dd></param>
|
|
<param name="dwLines"><dd> <p> Number of rows of pixels to copy. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This function copies a single plane of the image. For planar YUV formats, you must call the function once for each plane. In this case, <em>pDest</em> and <em>pSrc</em> must point to the start of each plane. </p><p> This function is optimized if the MMX, SSE, or SSE2 instruction sets are available on the processor. The function performs a non-temporal store (the data is written to memory directly without polluting the cache). </p><p><strong>Note</strong>??Prior to Windows?7, this function was exported from evr.dll. Starting in Windows?7, this function is exported from mfplat.dll, and evr.dll exports a stub function that calls into mfplat.dll. For more information, see Library Changes in Windows?7.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCopyImage']/*"/>
|
|
<msdn-id>bb970554</msdn-id>
|
|
<unmanaged>HRESULT MFCopyImage([Out, Buffer] unsigned char* pDest,[In] int lDestStride,[In, Buffer] const unsigned char* pSrc,[In] int lSrcStride,[In] unsigned int dwWidthInBytes,[In] unsigned int dwLines)</unmanaged>
|
|
<unmanaged-short>MFCopyImage</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMFByteStreamWrapper(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.ByteStream@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="streamRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="streamWrapperOut"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMFByteStreamWrapper']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMFByteStreamWrapper([In] IMFByteStream* pStream,[Out] IMFByteStream** ppStreamWrapper)</unmanaged>
|
|
<unmanaged-short>MFCreateMFByteStreamWrapper</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.TGetInfo(System.Guid,System.IntPtr,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32@,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32@,SharpDX.MediaFoundation.MediaAttributes@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets information from the registry about a Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="clsidMFT"><dd> <p> The CLSID of the MFT. </p> </dd></param>
|
|
<param name="szNameRef"><dd> <p> Receives a reference to a wide-character string containing the friendly name of the MFT. The caller must free the string by calling <strong>CoTaskMemFree</strong>. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="inputTypesOut"><dd> <p> Receives a reference to an array of <strong><see cref="T:SharpDX.MediaFoundation.TRegisterTypeInformation"/></strong> structures. Each member of the array describes an input format that the MFT supports. The caller must free the array by calling <strong>CoTaskMemFree</strong>. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="cInputTypesRef"><dd> <p> Receives the number of elements in the <em>ppInputTypes</em> array. If <em>ppInputTypes</em> is <strong><c>null</c></strong>, this parameter is ignored and can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="outputTypesOut"><dd> <p> Receives a reference to an array of <strong><see cref="T:SharpDX.MediaFoundation.TRegisterTypeInformation"/></strong> structures. Each member of the array describes an output format that the MFT supports. The caller must free the array by calling <strong>CoTaskMemFree</strong>. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="cOutputTypesRef"><dd> <p> Receives the number of elements in the <em>ppOutputType</em> array. If <em>ppOutputTypes</em> is <strong><c>null</c></strong>, this parameter is ignored and can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="attributesOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of an attribute store. The caller must release the interface. The attribute store might contain attributes that are stored in the registry for the specified MFT. (For more information, see <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegister(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],SharpDX.MediaFoundation.MediaAttributes)"/></strong>.) If no attributes are stored in the registry for this MFT, the attribute store is empty. </p> <p>This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTGetInfo']/*"/>
|
|
<msdn-id>ms703830</msdn-id>
|
|
<unmanaged>HRESULT MFTGetInfo([In] GUID clsidMFT,[Out, Optional] wchar_t** pszName,[Out, Buffer, Optional] MFT_REGISTER_TYPE_INFO** ppInputTypes,[Out, Optional] unsigned int* pcInputTypes,[Out, Buffer, Optional] MFT_REGISTER_TYPE_INFO** ppOutputTypes,[Out, Optional] unsigned int* pcOutputTypes,[Out, Optional] IMFAttributes** ppAttributes)</unmanaged>
|
|
<unmanaged-short>MFTGetInfo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.UnwrapMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates a media type that wraps another media type. </p>
|
|
</summary>
|
|
<param name="wrapRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type to wrap in a new media type. </p> </dd></param>
|
|
<param name="origOut"><dd> <p>A <see cref="T:System.Guid"/> that specifies the major type for the new media type. For a list of possible values, see Major Media Types. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> The original media type (<em>pOrig</em>) is stored in the new media type under the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.WrappedType"/></strong> attribute. To extract the original media type, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnwrapMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType@)"/></strong>. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFUnwrapMediaType']/*"/>
|
|
<msdn-id>ms701782</msdn-id>
|
|
<unmanaged>HRESULT MFUnwrapMediaType([In] IMFMediaType* pWrap,[Out] IMFMediaType** ppOrig)</unmanaged>
|
|
<unmanaged-short>MFUnwrapMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateWICBitmapBuffer(System.Guid,SharpDX.ComObject,SharpDX.MediaFoundation.MediaBuffer@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Creates a media buffer object that manages a Windows Imaging Component (WIC) bitmap.</p>
|
|
</summary>
|
|
<param name="riid"><dd> <p>Set this parameter to <code>__uuidof(<see cref="!:SharpDX.WIC.Bitmap"/>)</code>.</p> </dd></param>
|
|
<param name="unkSurfaceRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the bitmap surface. The bitmap surface must be a WIC bitmap that exposes the <strong><see cref="!:SharpDX.WIC.Bitmap"/></strong> interface.</p> </dd></param>
|
|
<param name="bufferOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateWICBitmapBuffer']/*"/>
|
|
<msdn-id>hh162764</msdn-id>
|
|
<unmanaged>HRESULT MFCreateWICBitmapBuffer([In] const GUID& riid,[In] IUnknown* punkSurface,[Out] IMFMediaBuffer** ppBuffer)</unmanaged>
|
|
<unmanaged-short>MFCreateWICBitmapBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItem2(System.Int32,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Puts an asynchronous operation on a work queue, with a specified priority.</p>
|
|
</summary>
|
|
<param name="dwQueue"><dd> <p> The identifier for the work queue. This value can specify one of the standard Media Foundation work queues, or a work queue created by the application. For list of standard Media Foundation work queues, see <strong>Work Queue Identifiers</strong>. To create a new work queue, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> or <see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueueEx(SharpDX.MediaFoundation.AsyncWorkqueueType,System.Int32@)"/>. </p> </dd></param>
|
|
<param name="priority"><dd> <p>The priority of the work item. Work items are performed in order of priority.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface. The caller must implement this interface. </p> </dd></param>
|
|
<param name="stateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked. </p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include the following.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALID_WORKQUEUE</strong></strong></dt> </dl> </td><td> <p>Invalid work queue identifier.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> function was not called, or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPutWorkItem2']/*"/>
|
|
<msdn-id>hh162784</msdn-id>
|
|
<unmanaged>HRESULT MFPutWorkItem2([In] unsigned int dwQueue,[In] int Priority,[In] IMFAsyncCallback* pCallback,[In, Optional] IUnknown* pState)</unmanaged>
|
|
<unmanaged-short>MFPutWorkItem2</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.BeginUnregisterWorkQueueWithMMCSS(System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="dwWorkQueueId"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="doneCallbackRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="doneStateRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBeginUnregisterWorkQueueWithMMCSS']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFBeginUnregisterWorkQueueWithMMCSS([In] unsigned int dwWorkQueueId,[In] IMFAsyncCallback* pDoneCallback,[In] IUnknown* pDoneState)</unmanaged>
|
|
<unmanaged-short>MFBeginUnregisterWorkQueueWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.BeginCreateFile(SharpDX.MediaFoundation.FileAccessmode,SharpDX.MediaFoundation.FileOpenmode,SharpDX.MediaFoundation.FileFlags,System.String,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Begins an asynchronous request to create a byte stream from a file.</p>
|
|
</summary>
|
|
<param name="accessMode"><dd> <p>The requested access mode, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileAccessmode"/></strong> enumeration.</p> </dd></param>
|
|
<param name="openMode"><dd> <p>The behavior of the function if the file already exists or does not exist, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileOpenmode"/></strong> enumeration.</p> </dd></param>
|
|
<param name="fFlags"><dd> <p>Bitwise <strong>OR</strong> of values from the <strong><see cref="T:SharpDX.MediaFoundation.FileFlags"/></strong> enumeration.</p> </dd></param>
|
|
<param name="wszFilePathRef"><dd> <p>Pointer to a null-terminated string containing the file name.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface</p> </dd></param>
|
|
<param name="stateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<param name="cancelCookieOut"><dd> <p>Receives an <strong><see cref="T:SharpDX.ComObject"/></strong> reference or the value <strong><c>null</c></strong>. If the value is not <strong><c>null</c></strong>, you can cancel the asynchronous operation by passing this reference to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CancelCreateFile(SharpDX.ComObject)"/></strong> function. The caller must release the interface. This parameter is optional and can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When the request is completed, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. The callback object should then call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.EndCreateFile(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ByteStream@)"/></strong> function to get a reference to the byte stream.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBeginCreateFile']/*"/>
|
|
<msdn-id>ms702074</msdn-id>
|
|
<unmanaged>HRESULT MFBeginCreateFile([In] MF_FILE_ACCESSMODE AccessMode,[In] MF_FILE_OPENMODE OpenMode,[In] MF_FILE_FLAGS fFlags,[In] const wchar_t* pwszFilePath,[In] IMFAsyncCallback* pCallback,[In] IUnknown* pState,[Out] IUnknown** ppCancelCookie)</unmanaged>
|
|
<unmanaged-short>MFBeginCreateFile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.IsFormatYUV(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="format"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFIsFormatYUV']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>BOOL MFIsFormatYUV([In] unsigned int Format)</unmanaged>
|
|
<unmanaged-short>MFIsFormatYUV</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.ConvertColorInfoFromDXVA(SharpDX.MediaFoundation.Videoformat@,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="toFormatRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="dwFromDXVA"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFConvertColorInfoFromDXVA']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFConvertColorInfoFromDXVA([InOut] MFVIDEOFORMAT* pToFormat,[In] unsigned int dwFromDXVA)</unmanaged>
|
|
<unmanaged-short>MFConvertColorInfoFromDXVA</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.EndCreateFile(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ByteStream@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Begins an asynchronous request to create a byte stream from a file.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>The requested access mode, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileAccessmode"/></strong> enumeration.</p> </dd></param>
|
|
<param name="fileOut"><dd> <p>The behavior of the function if the file already exists or does not exist, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileOpenmode"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When the request is completed, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. The callback object should then call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.EndCreateFile(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ByteStream@)"/></strong> function to get a reference to the byte stream.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFEndCreateFile']/*"/>
|
|
<msdn-id>ms702074</msdn-id>
|
|
<unmanaged>HRESULT MFEndCreateFile([In] IMFAsyncResult* pResult,[Out] IMFByteStream** ppFile)</unmanaged>
|
|
<unmanaged-short>MFEndCreateFile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.ScheduleWorkItemEx(SharpDX.MediaFoundation.AsyncResult,System.Int64,System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Attempts to cancel an asynchronous operation that was scheduled with <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.ScheduleWorkItem(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,System.Int64,System.Int64@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.ScheduleWorkItemEx(SharpDX.MediaFoundation.AsyncResult,System.Int64,System.Int64@)"/></strong>.</p>
|
|
</summary>
|
|
<param name="resultRef">No documentation.</param>
|
|
<param name="timeout">No documentation.</param>
|
|
<param name="keyRef">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Because work items are asynchronous, the work-item callback might still be invoked after <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CancelWorkItem(System.Int64)"/></strong> is called.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFScheduleWorkItemEx']/*"/>
|
|
<msdn-id>ms701633</msdn-id>
|
|
<unmanaged>HRESULT MFScheduleWorkItemEx([In] IMFAsyncResult* pResult,[In] longlong Timeout,[Out, Optional] unsigned longlong* pKey)</unmanaged>
|
|
<unmanaged-short>MFScheduleWorkItemEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.LockWorkQueue(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Locks a work queue.</p>
|
|
</summary>
|
|
<param name="dwWorkQueue"><dd> <p>The identifier for the work queue. The identifier is returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> function. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function prevents the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> function from shutting down the work queue. Use this function to ensure that asynchronous operations on the work queue complete gracefully before the platform shuts down. The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> function blocks until the work queue is unlocked, or until a fixed wait period has elapsed. (The wait period is a few seconds.)</p><p>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockWorkQueue(System.Int32)"/></strong> to unlock the work queue. Each call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockWorkQueue(System.Int32)"/></strong> must be matched by a corresponding call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockWorkQueue(System.Int32)"/></strong>.</p><p> </p><p><strong>Note</strong>??The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> function implicitly locks the work queue that it creates.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFLockWorkQueue']/*"/>
|
|
<msdn-id>aa367740</msdn-id>
|
|
<unmanaged>HRESULT MFLockWorkQueue([In] unsigned int dwWorkQueue)</unmanaged>
|
|
<unmanaged-short>MFLockWorkQueue</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoMediaTypeFromBitMapInfoHeaderEx(SharpDX.Win32.BitmapInfoHeader[],System.Int32,System.Int32,System.Int32,SharpDX.MediaFoundation.VideoInterlaceMode,System.Int64,System.Int32,System.Int32,System.Int32,SharpDX.MediaFoundation.VideoMediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates a video media type from a <strong><see cref="T:SharpDX.Win32.BitmapInfoHeader"/></strong> structure.</p>
|
|
</summary>
|
|
<param name="bmihBitMapInfoHeaderRef">No documentation.</param>
|
|
<param name="cbBitMapInfoHeader">No documentation.</param>
|
|
<param name="dwPixelAspectRatioX">No documentation.</param>
|
|
<param name="dwPixelAspectRatioY">No documentation.</param>
|
|
<param name="interlaceMode">No documentation.</param>
|
|
<param name="videoFlags">No documentation.</param>
|
|
<param name="dwFramesPerSecondNumerator">No documentation.</param>
|
|
<param name="dwFramesPerSecondDenominator">No documentation.</param>
|
|
<param name="dwMaxBitRate">No documentation.</param>
|
|
<param name="iVideoMediaTypeOut">No documentation.</param>
|
|
<returns><p>If the function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoMediaTypeFromBitMapInfoHeaderEx']/*"/>
|
|
<msdn-id>dd388121</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoMediaTypeFromBitMapInfoHeaderEx([In, Buffer] const BITMAPINFOHEADER* pbmihBitMapInfoHeader,[In] unsigned int cbBitMapInfoHeader,[In] unsigned int dwPixelAspectRatioX,[In] unsigned int dwPixelAspectRatioY,[In] MFVideoInterlaceMode InterlaceMode,[In] unsigned longlong VideoFlags,[In] unsigned int dwFramesPerSecondNumerator,[In] unsigned int dwFramesPerSecondDenominator,[In] unsigned int dwMaxBitRate,[Out] IMFVideoMediaType** ppIVideoMediaType)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoMediaTypeFromBitMapInfoHeaderEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Creates an asynchronous result object. Use this function if you are implementing an asynchronous method.</p>
|
|
</summary>
|
|
<param name="unkObjectRef"><dd> <p>Pointer to the object stored in the asynchronous result. This reference is returned by the <strong><see cref="M:SharpDX.MediaFoundation.AsyncResult.GetObjectW(SharpDX.ComObject@)"/></strong> method. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface. This interface is implemented by the caller of the asynchronous method.</p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object. This value is provided by the caller of the asynchronous method. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="asyncResultOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To invoke the callback specified in <em>pCallback</em>, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.InvokeCallback(SharpDX.MediaFoundation.AsyncResult)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateAsyncResult']/*"/>
|
|
<msdn-id>ms698952</msdn-id>
|
|
<unmanaged>HRESULT MFCreateAsyncResult([In] IUnknown* punkObject,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState,[Out] IMFAsyncResult** ppAsyncResult)</unmanaged>
|
|
<unmanaged-short>MFCreateAsyncResult</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.InitMediaTypeFromWaveFormatEx(SharpDX.MediaFoundation.MediaType,SharpDX.Multimedia.WaveFormat[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Initializes a media type from a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure. </p>
|
|
</summary>
|
|
<param name="mFTypeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type to initialize. To create the uninitialized media type object, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaType(SharpDX.MediaFoundation.MediaType@)"/></strong>.</p> </dd></param>
|
|
<param name="waveFormatRef"><dd> <p>Pointer to a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure that describes the media type. The caller must fill in the structure members before calling this function.</p> </dd></param>
|
|
<param name="cbBufSize"><dd> <p>Size of the <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure, in bytes.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFInitMediaTypeFromWaveFormatEx']/*"/>
|
|
<msdn-id>ms700801</msdn-id>
|
|
<unmanaged>HRESULT MFInitMediaTypeFromWaveFormatEx([In] IMFMediaType* pMFType,[In, Buffer] const WAVEFORMATEX* pWaveFormat,[In] unsigned int cbBufSize)</unmanaged>
|
|
<unmanaged-short>MFInitMediaTypeFromWaveFormatEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.LockSharedWorkQueue(System.String,System.Int32,System.Int32@,System.Int32@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Obtains and locks a shared work queue.</p>
|
|
</summary>
|
|
<param name="wszClass"><dd> <p>The name of the MMCSS task. </p> </dd></param>
|
|
<param name="basePriority"><dd> <p>The base priority of the work-queue threads. If the regular-priority queue is being used (<em>wszClass</em>=""), then the value 0 must be passed in.</p> </dd></param>
|
|
<param name="dwTaskIdRef"><dd> <p>The MMCSS task identifier. On input, specify an existing MCCSS task group ID , or use the value zero to create a new task group. If the regular priority queue is being used (<em>wszClass</em>=""), then <strong><c>null</c></strong> must be passed in. On output, receives the actual task group ID. </p> </dd></param>
|
|
<param name="iDRef"><dd> <p>Receives an identifier for the new work queue. Use this identifier when queuing work items.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>A <em>multithreaded work queue</em> uses a thread pool to dispatch work items. Whenever a thread becomes available, it dequeues the next work item from the queue. Work items are dequeued in first-in-first-out order, but work items are not serialized. In other words, the work queue does not wait for a work item to complete before it starts the next work item. </p><p>Within a single process, the Microsoft Media Foundation platform creates up to one multithreaded queue for each Multimedia Class Scheduler Service (MMCSS) task. The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockSharedWorkQueue(System.String,System.Int32,System.Int32@,System.Int32@)"/></strong> function checks whether a matching work queue already exists. If not, the function creates a new work queue and registers the work queue with MMCSS. The function returns the MMCSS task identifier (<em>pdwTaskId</em>) and the work queue identifier (<em>pID</em>). To queue a work item, pass the work queue identifier to any of the following functions: </p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItem(System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItem2(System.Int32,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItemEx(System.Int32,SharpDX.MediaFoundation.AsyncResult)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItemEx2(System.Int32,System.Int32,SharpDX.MediaFoundation.AsyncResult)"/></strong> </li> </ul><p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockSharedWorkQueue(System.String,System.Int32,System.Int32@,System.Int32@)"/></strong> function also locks the queue. Before the process exits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockWorkQueue(System.Int32)"/></strong> to unlock the work queue.</p><p>If the regular priority queue is being used (<em>wszClass</em>=""), then <c>null</c> must be passed in to <em>pdwTaskId</em> and the value 0 must be passed into <em>BasePriority</em>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFLockSharedWorkQueue']/*"/>
|
|
<msdn-id>hh162771</msdn-id>
|
|
<unmanaged>HRESULT MFLockSharedWorkQueue([In] const wchar_t* wszClass,[In] int BasePriority,[InOut] unsigned int* pdwTaskId,[Out] unsigned int* pID)</unmanaged>
|
|
<unmanaged-short>MFLockSharedWorkQueue</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.MapDXGIFormatToDX9Format(SharpDX.DXGI.Format)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Converts a Microsoft DirectX Graphics Infrastructure (DXGI) format identifier to a Microsoft Direct3D?9 format identifier.</p>
|
|
</summary>
|
|
<param name="dx11"><dd> <p>The <strong><see cref="T:SharpDX.DXGI.Format"/></strong> value to convert.</p> </dd></param>
|
|
<returns><p>Returns a <strong>D3DFORMAT</strong> value or FOURCC code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMapDXGIFormatToDX9Format']/*"/>
|
|
<msdn-id>hh162773</msdn-id>
|
|
<unmanaged>unsigned int MFMapDXGIFormatToDX9Format([In] DXGI_FORMAT dx11)</unmanaged>
|
|
<unmanaged-short>MFMapDXGIFormatToDX9Format</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.ConvertColorInfoToDXVA(System.Int32@,SharpDX.MediaFoundation.Videoformat@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="dwToDXVARef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="fromFormatRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFConvertColorInfoToDXVA']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFConvertColorInfoToDXVA([Out] unsigned int* pdwToDXVA,[In] const MFVIDEOFORMAT* pFromFormat)</unmanaged>
|
|
<unmanaged-short>MFConvertColorInfoToDXVA</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateTempFile(SharpDX.MediaFoundation.FileAccessmode,SharpDX.MediaFoundation.FileOpenmode,SharpDX.MediaFoundation.FileFlags,SharpDX.MediaFoundation.ByteStream@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates a byte stream that is backed by a temporary local file. </p>
|
|
</summary>
|
|
<param name="accessMode"><dd> <p> The requested access mode, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileAccessmode"/></strong> enumeration. </p> </dd></param>
|
|
<param name="openMode"><dd> <p> The behavior of the function if the file already exists or does not exist, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileOpenmode"/></strong> enumeration. </p> </dd></param>
|
|
<param name="fFlags"><dd> <p> Bitwise <strong>OR</strong> of values from the <strong><see cref="T:SharpDX.MediaFoundation.FileFlags"/></strong> enumeration. </p> </dd></param>
|
|
<param name="iByteStreamOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of the byte stream. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This function creates a file in the system temporary folder, and then returns a byte stream object for that file. The full path name of the file is storted in the <strong><see cref="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.OriginName"/></strong> attribute. The file is created with the <strong>FILE_FLAG_DELETE_ON_CLOSE</strong> flag, and is deleted after the byte stream is released.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateTempFile']/*"/>
|
|
<msdn-id>ms695209</msdn-id>
|
|
<unmanaged>HRESULT MFCreateTempFile([In] MF_FILE_ACCESSMODE AccessMode,[In] MF_FILE_OPENMODE OpenMode,[In] MF_FILE_FLAGS fFlags,[Out] IMFByteStream** ppIByteStream)</unmanaged>
|
|
<unmanaged-short>MFCreateTempFile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetAttributesAsBlobSize(SharpDX.MediaFoundation.MediaAttributes,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the size of the buffer needed for the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.GetAttributesAsBlob(SharpDX.MediaFoundation.MediaAttributes,System.Byte[],System.Int32)"/></strong> function.</p>
|
|
</summary>
|
|
<param name="attributesRef">No documentation.</param>
|
|
<param name="cbBufSizeRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Use this function to find the size of the array that is needed for the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.GetAttributesAsBlob(SharpDX.MediaFoundation.MediaAttributes,System.Byte[],System.Int32)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetAttributesAsBlobSize']/*"/>
|
|
<msdn-id>ms697064</msdn-id>
|
|
<unmanaged>HRESULT MFGetAttributesAsBlobSize([In] IMFAttributes* pAttributes,[Out] unsigned int* pcbBufSize)</unmanaged>
|
|
<unmanaged-short>MFGetAttributesAsBlobSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetPluginControl(SharpDX.MediaFoundation.PluginControl@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets a reference to the Microsoft Media Foundation plug-in manager.</p>
|
|
</summary>
|
|
<param name="pluginControlOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.PluginControl"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetPluginControl']/*"/>
|
|
<msdn-id>dd388507</msdn-id>
|
|
<unmanaged>HRESULT MFGetPluginControl([Out] IMFPluginControl** ppPluginControl)</unmanaged>
|
|
<unmanaged-short>MFGetPluginControl</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetTimerPeriodicity(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="periodicity"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetTimerPeriodicity']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFGetTimerPeriodicity([Out] unsigned int* Periodicity)</unmanaged>
|
|
<unmanaged-short>MFGetTimerPeriodicity</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates a new work queue.</p>
|
|
</summary>
|
|
<param name="dwWorkQueueRef"><dd> <p>Receives an identifier for the work queue.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The function succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_FAIL</strong></dt> </dl> </td><td> <p> The application exceeded the maximum number of work queues. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p> The application did not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>, or the application has already called <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong>. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When you are done using the work queue, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockWorkQueue(System.Int32)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAllocateWorkQueue']/*"/>
|
|
<msdn-id>ms700204</msdn-id>
|
|
<unmanaged>HRESULT MFAllocateWorkQueue([Out] unsigned int* pdwWorkQueue)</unmanaged>
|
|
<unmanaged-short>MFAllocateWorkQueue</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.InitVideoFormatRgb(SharpDX.MediaFoundation.Videoformat@,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="videoFormatRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="dwWidth"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="dwHeight">No documentation.</param>
|
|
<param name="d3Dfmt">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFInitVideoFormat_RGB']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFInitVideoFormat_RGB([In] MFVIDEOFORMAT* pVideoFormat,[In] unsigned int dwWidth,[In] unsigned int dwHeight,[In] unsigned int D3Dfmt)</unmanaged>
|
|
<unmanaged-short>MFInitVideoFormat_RGB</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.ConvertToFP16Array(System.Int16[],System.Single[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="destRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="srcRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="dwCount">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFConvertToFP16Array']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFConvertToFP16Array([Out, Buffer] unsigned short* pDest,[In, Buffer] const float* pSrc,[In] unsigned int dwCount)</unmanaged>
|
|
<unmanaged-short>MFConvertToFP16Array</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.AllocateSerialWorkQueue(System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates a work queue that is guaranteed to serialize work items. The serial work queue wraps an existing multithreaded work queue. The serial work queue enforces a first-in, first-out (FIFO) execution order.</p>
|
|
</summary>
|
|
<param name="dwWorkQueue"><dd> <p> The identifier of an existing work queue. This must be either a multithreaded queue or another serial work queue. Any of the following can be used:</p> <ul> <li>The default work queue (<strong>MFASYNC_CALLBACK_QUEUE_STANDARD</strong>)</li> <li>The platform multithreaded queue (<strong>MFASYNC_CALLBACK_QUEUE_MULTITHREADED</strong>)</li> <li>A multithreaded queue returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockSharedWorkQueue(System.String,System.Int32,System.Int32@,System.Int32@)"/></strong> function.</li> <li>A serial queue created by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateSerialWorkQueue(System.Int32,System.Int32@)"/></strong> function.</li> </ul> </dd></param>
|
|
<param name="dwWorkQueueRef"><dd> <p>Receives an identifier for the new serial work queue. Use this identifier when queuing work items.</p> </dd></param>
|
|
<returns><p>This function can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The function succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_FAIL</strong></dt> </dl> </td><td> <p> The application exceeded the maximum number of work queues. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p> The application did not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>, or the application has already called <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong>. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When you are done using the work queue, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockWorkQueue(System.Int32)"/></strong>.</p><p>Multithreaded queues use a thread pool, which can reduce the total number of threads in the pipeline. However, they do not serialize work items. A serial work queue enables the application to get the benefits of the thread pool, without needing to perform manual serialization of its own work items.</p>Reply Mode<p>A serializer queue can also work in "reply" mode. If the caller?s <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.GetParameters(System.Int32@,System.Int32@)"/></strong> method returns the <strong>MFASYNC_REPLY_CALLBACK</strong> flag, the serializer queue does not automatically advance to the next work item. Instead, the queue waits for a reply from the caller. The caller signals the reply by invoking the asynchronous result object that the work queue passes to the <strong>Invoke</strong> method. The following code illustrates how the caller signals the work queue.</p><pre><see cref="T:SharpDX.Result"/> CCallback::Invoke(<see cref="T:SharpDX.MediaFoundation.AsyncResult"/> *pResult)
|
|
{ DoSomeWork(); // Reply to the work queue that you are done. <see cref="M:SharpDX.MediaFoundation.MediaFactory.InvokeCallback(SharpDX.MediaFoundation.AsyncResult)"/>(pResult); // Note: This call to <see cref="M:SharpDX.MediaFoundation.MediaFactory.InvokeCallback(SharpDX.MediaFoundation.AsyncResult)"/> does not have to occur inside the // Invoke method. You could call <see cref="M:SharpDX.MediaFoundation.MediaFactory.InvokeCallback(SharpDX.MediaFoundation.AsyncResult)"/> at a later time. return <see cref="F:SharpDX.Result.Ok"/>;
|
|
}
|
|
<see cref="T:SharpDX.Result"/> CCallback::GetParameters(DWORD *pdwFlags, DWORD *pdwQueue)
|
|
{ *pdwFlags = MFASYNC_REPLY_CALLBACK; *pdwQueue = m_QueueId; return <see cref="F:SharpDX.Result.Ok"/>;
|
|
}
|
|
</pre>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAllocateSerialWorkQueue']/*"/>
|
|
<msdn-id>hh162744</msdn-id>
|
|
<unmanaged>HRESULT MFAllocateSerialWorkQueue([In] unsigned int dwWorkQueue,[Out] unsigned int* pdwWorkQueue)</unmanaged>
|
|
<unmanaged-short>MFAllocateSerialWorkQueue</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.InitAttributesFromBlob(SharpDX.MediaFoundation.MediaAttributes,System.Byte[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="attributesRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="bufRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="cbBufSize">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFInitAttributesFromBlob']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFInitAttributesFromBlob([In] IMFAttributes* pAttributes,[In, Buffer] const unsigned char* pBuf,[In] unsigned int cbBufSize)</unmanaged>
|
|
<unmanaged-short>MFInitAttributesFromBlob</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.UnlockDXGIDeviceManager">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Unlocks the shared Microsoft DirectX Graphics Infrastructure (DXGI) Device Manager.</p>
|
|
</summary>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call this function after a successful call to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockDXGIDeviceManager(System.Int32@,SharpDX.MediaFoundation.DXGIDeviceManager@)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFUnlockDXGIDeviceManager']/*"/>
|
|
<msdn-id>hh162800</msdn-id>
|
|
<unmanaged>HRESULT MFUnlockDXGIDeviceManager()</unmanaged>
|
|
<unmanaged-short>MFUnlockDXGIDeviceManager</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.AverageTimePerFrameToFrameRate(System.Int64,System.Int32@,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Converts a video frame rate into a frame duration.</p>
|
|
</summary>
|
|
<param name="unAverageTimePerFrame"><dd> <p>The numerator of the frame rate. </p> </dd></param>
|
|
<param name="unNumeratorRef"><dd> <p> The denominator of the frame rate. </p> </dd></param>
|
|
<param name="unDenominatorRef"><dd> <p> Receives the average duration of a video frame, in 100-nanosecond units. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function is useful for calculating time stamps on a sample, given the frame rate.</p><p>Also, average time per frame is used in the older <strong><see cref="!:SharpDX.Win32.Unsupported.VideoInfoHeader"/></strong> and <strong><see cref="!:SharpDX.MediaFoundation.VideoInformationHeader2"/></strong> format structures. This function provides a standard conversion so that all components in the pipeline can use consistent values, if they need to translate between the older format structures and the media type attributes used in Media Foundation.</p><p> For certain common frame rates, the function gets the frame duration from a look-up table:</p><table> <tr><th>Frames per second (floating point)</th><th>Frames per second (fractional)</th><th>Average time per frame</th></tr> <tr><td>59.94</td><td>60000/1001</td><td>166833</td></tr> <tr><td>29.97</td><td>30000/1001</td><td>333667</td></tr> <tr><td>23.976</td><td>24000/1001</td><td>417188</td></tr> <tr><td>60</td><td>60/1</td><td>166667</td></tr> <tr><td>30</td><td>30/1</td><td>333333</td></tr> <tr><td>50</td><td>50/1</td><td>200000</td></tr> <tr><td>25</td><td>25/1</td><td>400000</td></tr> <tr><td>24</td><td>24/1</td><td>416667</td></tr> </table><p>?</p><p> Most video content uses one of the frame rates listed here. For other frame rates, the function calculates the duration.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAverageTimePerFrameToFrameRate']/*"/>
|
|
<msdn-id>aa370467</msdn-id>
|
|
<unmanaged>HRESULT MFAverageTimePerFrameToFrameRate([In] unsigned longlong unAverageTimePerFrame,[Out] unsigned int* punNumerator,[Out] unsigned int* punDenominator)</unmanaged>
|
|
<unmanaged-short>MFAverageTimePerFrameToFrameRate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateDXGIDeviceManager(System.Int32@,SharpDX.MediaFoundation.DXGIDeviceManager)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates an instance of the Microsoft DirectX Graphics Infrastructure (DXGI) Device Manager.</p>
|
|
</summary>
|
|
<param name="resetToken"><dd> <p> Receives a token that identifies this instance of the DXGI Device Manager. Use this token when calling <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.ResetDevice(SharpDX.ComObject,System.Int32)"/></strong>. </p> </dd></param>
|
|
<param name="deviceManagerOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.DXGIDeviceManager"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateDXGIDeviceManager']/*"/>
|
|
<msdn-id>hh162750</msdn-id>
|
|
<unmanaged>HRESULT MFCreateDXGIDeviceManager([Out] unsigned int* resetToken,[Out, Fast] IMFDXGIDeviceManager** ppDeviceManager)</unmanaged>
|
|
<unmanaged-short>MFCreateDXGIDeviceManager</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItem(System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Puts an asynchronous operation on a work queue.</p>
|
|
</summary>
|
|
<param name="dwQueue"><dd> <p> The identifier for the work queue. This value can specify one of the standard Media Foundation work queues, or a work queue created by the application. For list of standard Media Foundation work queues, see <strong>Work Queue Identifiers</strong>. To create a new work queue, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueueEx(SharpDX.MediaFoundation.AsyncWorkqueueType,System.Int32@)"/></strong>. </p> </dd></param>
|
|
<param name="callbackRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface. The caller must implement this interface. </p> </dd></param>
|
|
<param name="stateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked. </p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include the following.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALID_WORKQUEUE</strong></strong></dt> </dl> </td><td> <p>Invalid work queue. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.GetParameters(System.Int32@,System.Int32@)"/></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> function was not called, or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> This function creates an asynchronous result object and puts the result object on the work queue. The work queue calls the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method specified by <em>pCallback</em>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPutWorkItem']/*"/>
|
|
<msdn-id>ms702164</msdn-id>
|
|
<unmanaged>HRESULT MFPutWorkItem([In] unsigned int dwQueue,[In] IMFAsyncCallback* pCallback,[In] IUnknown* pState)</unmanaged>
|
|
<unmanaged-short>MFPutWorkItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaBufferFromMediaType(SharpDX.MediaFoundation.MediaType,System.Int64,System.Int32,System.Int32,SharpDX.MediaFoundation.MediaBuffer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="mediaTypeRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="llDuration"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="dwMinLength">No documentation.</param>
|
|
<param name="dwMinAlignment">No documentation.</param>
|
|
<param name="bufferOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMediaBufferFromMediaType']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMediaBufferFromMediaType([In] IMFMediaType* pMediaType,[In] longlong llDuration,[In] unsigned int dwMinLength,[In] unsigned int dwMinAlignment,[Out] IMFMediaBuffer** ppBuffer)</unmanaged>
|
|
<unmanaged-short>MFCreateMediaBufferFromMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.TUnregister(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Unregisters a Media Foundation transform (MFT) from the caller's process.</p>
|
|
</summary>
|
|
<param name="clsidMFT"><dd> <p>The class identifier (CLSID) of the MFT.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>HRESULT_FROM_WIN32(<strong><see cref="F:SharpDX.Win32.ErrorCode.NotFound"/></strong>)</strong></dt> </dl> </td><td> <p>The MFT specified by the <em>clsidMFT</em> parameter was not registered in this process.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Use this function to unregister a local MFT that was previously registered through the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocalByCLSID(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTUnregister']/*"/>
|
|
<msdn-id>dd388659</msdn-id>
|
|
<unmanaged>HRESULT MFTUnregister([In] GUID clsidMFT)</unmanaged>
|
|
<unmanaged-short>MFTUnregister</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetWorkQueueMMCSSTaskId(System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="dwWorkQueueId"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="dwTaskIdRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetWorkQueueMMCSSTaskId']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFGetWorkQueueMMCSSTaskId([In] unsigned int dwWorkQueueId,[Out] unsigned int* pdwTaskId)</unmanaged>
|
|
<unmanaged-short>MFGetWorkQueueMMCSSTaskId</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaBufferWrapper(SharpDX.MediaFoundation.MediaBuffer,System.Int32,System.Int32,SharpDX.MediaFoundation.MediaBuffer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates a media buffer that wraps an existing media buffer. The new media buffer points to the same memory as the original media buffer, or to an offset from the start of the memory.</p>
|
|
</summary>
|
|
<param name="bufferRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface of the original media buffer. </p> </dd></param>
|
|
<param name="cbOffset"><dd> <p>The start of the new buffer, as an offset in bytes from the start of the original buffer. </p> </dd></param>
|
|
<param name="dwLength"><dd> <p>The size of the new buffer. The value of <em>cbOffset</em> + <em>dwLength</em> must be less than or equal to the size of valid data the original buffer. (The size of the valid data is returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetCurrentLength(System.Int32@)"/></strong> method.) </p> </dd></param>
|
|
<param name="bufferOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The function succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> The requested offset or the requested length is not valid. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The maximum size of the wrapper buffer is limited to the size of the valid data in the original buffer. This might be less than the allocated size of the original buffer. To set the size of the valid data, call <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.SetCurrentLength(System.Int32)"/></strong>.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMediaBufferWrapper']/*"/>
|
|
<msdn-id>aa370450</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMediaBufferWrapper([In] IMFMediaBuffer* pBuffer,[In] unsigned int cbOffset,[In] unsigned int dwLength,[Out] IMFMediaBuffer** ppBuffer)</unmanaged>
|
|
<unmanaged-short>MFCreateMediaBufferWrapper</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.UnlockPlatform">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Unlocks the Media Foundation platform after it was locked by a call to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockPlatform"/></strong> function.</p>
|
|
</summary>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The application must call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockPlatform"/></strong> once for every call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockPlatform"/></strong>.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFUnlockPlatform']/*"/>
|
|
<msdn-id>ms703879</msdn-id>
|
|
<unmanaged>HRESULT MFUnlockPlatform()</unmanaged>
|
|
<unmanaged-short>MFUnlockPlatform</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CalculateBitmapImageSize(SharpDX.Win32.BitmapInfoHeader[],System.Int32,System.Int32@,System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Retrieves the image size for a video format. Given a <strong><see cref="T:SharpDX.Win32.BitmapInfoHeader"/></strong> structure, this function calculates the correct value of the <strong>biSizeImage</strong> member. </p>
|
|
</summary>
|
|
<param name="bMIHRef">No documentation.</param>
|
|
<param name="cbBufSize">No documentation.</param>
|
|
<param name="cbImageSizeRef">No documentation.</param>
|
|
<param name="bKnownRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The function succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> The <strong><see cref="T:SharpDX.Win32.BitmapInfoHeader"/></strong> structure is not valid, or the value of <em>cbBufSize</em> is too small. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> Before calling this function, you must set at least the following members of the <strong><see cref="T:SharpDX.Win32.BitmapInfoHeader"/></strong> structure:</p><ul> <li><strong>biCompression</strong></li> <li><strong>biBitCount</strong></li> <li><strong>biWidth</strong></li> <li><strong>biHeight</strong></li> </ul><p>Also, if <strong>biCompression</strong> is <strong>BI_BITFIELDS</strong>, the <strong><see cref="T:SharpDX.Win32.BitmapInfoHeader"/></strong> structure must be followed by an array of color masks. </p><p> This function fails if the <strong><see cref="T:SharpDX.Win32.BitmapInfoHeader"/></strong> structure describes a format that is not a video format. For example, it fails if <strong>biCompresson</strong> is <strong>BI_JPEG</strong> or <strong>BI_PNG</strong> .</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCalculateBitmapImageSize']/*"/>
|
|
<msdn-id>ms697582</msdn-id>
|
|
<unmanaged>HRESULT MFCalculateBitmapImageSize([In, Buffer] const BITMAPINFOHEADER* pBMIH,[In] unsigned int cbBufSize,[Out] unsigned int* pcbImageSize,[Out, Optional] BOOL* pbKnown)</unmanaged>
|
|
<unmanaged-short>MFCalculateBitmapImageSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateEventQueue(SharpDX.MediaFoundation.MediaEventQueue@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Creates an event queue.</p>
|
|
</summary>
|
|
<param name="mediaEventQueueOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaEventQueue"/></strong> interface of the event queue. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This function creates a helper object that you can use to implement the <strong><see cref="T:SharpDX.MediaFoundation.MediaEventGenerator"/></strong> interface.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateEventQueue']/*"/>
|
|
<msdn-id>ms695252</msdn-id>
|
|
<unmanaged>HRESULT MFCreateEventQueue([Out] IMFMediaEventQueue** ppMediaEventQueue)</unmanaged>
|
|
<unmanaged-short>MFCreateEventQueue</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateDXSurfaceBuffer(System.Guid,SharpDX.ComObject,System.Boolean,SharpDX.MediaFoundation.MediaBuffer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates a media buffer object that manages a Direct3D 9 surface. </p>
|
|
</summary>
|
|
<param name="riid"><dd> <p> Identifies the type of Direct3D 9 surface. Currently this value must be <strong>IID_IDirect3DSurface9</strong>. </p> </dd></param>
|
|
<param name="unkSurfaceRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the DirectX surface. </p> </dd></param>
|
|
<param name="fBottomUpWhenLinear"><dd> <p> If <strong>TRUE</strong>, the buffer's <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.ContiguousCopyTo(System.Byte[],System.Int32)"/></strong> method copies the buffer into a bottom-up format. The bottom-up format is compatible with GDI for uncompressed RGB images. If this parameter is <strong><see cref="F:SharpDX.Result.False"/></strong>, the <strong>ContiguousCopyTo</strong> method copies the buffer into a top-down format, which is compatible with DirectX. </p> <p>For more information about top-down versus bottom-up images, see Image Stride.</p> </dd></param>
|
|
<param name="bufferOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface. The caller must release the buffer. </p> </dd></param>
|
|
<returns><p> The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This function creates a media buffer object that holds a reference to the Direct3D surface specified in <em>punkSurface</em>. Locking the buffer gives the caller access to the surface memory. When the buffer object is destroyed, it releases the surface. For more information about media buffers, see Media Buffers.</p><p><strong>Note</strong>??This function does not allocate the Direct3D surface itself.</p><p> The buffer object created by this function also exposes the <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> interface. For more information, see DirectX Surface Buffer. </p><p>This function does not support DXGI surfaces.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateDXSurfaceBuffer']/*"/>
|
|
<msdn-id>ms703840</msdn-id>
|
|
<unmanaged>HRESULT MFCreateDXSurfaceBuffer([In] const GUID& riid,[In] IUnknown* punkSurface,[In] BOOL fBottomUpWhenLinear,[Out] IMFMediaBuffer** ppBuffer)</unmanaged>
|
|
<unmanaged-short>MFCreateDXSurfaceBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.BeginRegisterWorkQueueWithMMCSS(System.Int32,System.String,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="dwWorkQueueId"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="wszClass"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="dwTaskId">No documentation.</param>
|
|
<param name="doneCallbackRef">No documentation.</param>
|
|
<param name="doneStateRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBeginRegisterWorkQueueWithMMCSS']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFBeginRegisterWorkQueueWithMMCSS([In] unsigned int dwWorkQueueId,[In] const wchar_t* wszClass,[In] unsigned int dwTaskId,[In] IMFAsyncCallback* pDoneCallback,[In] IUnknown* pDoneState)</unmanaged>
|
|
<unmanaged-short>MFBeginRegisterWorkQueueWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoMediaTypeFromSubtype(System.Guid,SharpDX.MediaFoundation.VideoMediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="aMSubtypeRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="iVideoMediaTypeOut"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoMediaTypeFromSubtype']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoMediaTypeFromSubtype([In] const GUID* pAMSubtype,[Out] IMFVideoMediaType** ppIVideoMediaType)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoMediaTypeFromSubtype</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSample(SharpDX.MediaFoundation.Sample@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Creates an empty media sample.</p>
|
|
</summary>
|
|
<param name="iMFSampleOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of the media sample. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Initially the sample does not contain any media buffers.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSample']/*"/>
|
|
<msdn-id>ms702276</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSample([Out] IMFSample** ppIMFSample)</unmanaged>
|
|
<unmanaged-short>MFCreateSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaTypeFromRepresentation(System.Guid,System.IntPtr,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates a Media Foundation media type from another format representation.</p>
|
|
</summary>
|
|
<param name="guidRepresentation"><dd> <p><see cref="T:System.Guid"/> that specifies which format representation to convert. The following value is defined.</p> <table> <tr><th><see cref="T:System.Guid"/></th><th>Description</th></tr> <tr><td>AM_MEDIA_TYPE_REPRESENTATION</td><td>Convert a DirectShow <strong><see cref="!:SharpDX.Win32.Unsupported.AMMediaType"/></strong> structure.</td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="vRepresentationRef"><dd> <p>Pointer to a buffer that contains the format representation to convert. The layout of the buffer depends on the value of <em>guidRepresentation</em>.</p> </dd></param>
|
|
<param name="iMediaTypeOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_REPRESENTATION</strong></dt> </dl> </td><td> <p>The <see cref="T:System.Guid"/> specified in <em>guidRepresentation</em> is not supported.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the original format is a DirectShow audio media type, and the format type is not recognized, the function sets the following attributes on the converted media type.</p><table> <tr><th>Attribute</th><th>Description</th></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AmFormatType"/></strong> </td><td>Contains the format type <see cref="T:System.Guid"/>.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.UserData"/></strong> </td><td>Contains the format block.</td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMediaTypeFromRepresentation']/*"/>
|
|
<msdn-id>aa369931</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMediaTypeFromRepresentation([In] GUID guidRepresentation,[In] void* pvRepresentation,[Out] IMFMediaType** ppIMediaType)</unmanaged>
|
|
<unmanaged-short>MFCreateMediaTypeFromRepresentation</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetStrideForBitmapInfoHeader(System.Int32,System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Calculates the minimum surface stride for a video format. </p>
|
|
</summary>
|
|
<param name="format"><dd> <p>FOURCC code or <strong>D3DFORMAT</strong> value that specifies the video format. If you have a video subtype <see cref="T:System.Guid"/>, you can use the first <strong>DWORD</strong> of the subtype.</p> </dd></param>
|
|
<param name="dwWidth"><dd> <p>Width of the image, in pixels.</p> </dd></param>
|
|
<param name="strideRef"><dd> <p>Receives the minimum surface stride, in pixels.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This function calculates the minimum stride needed to hold the image in memory. Use this function if you are allocating buffers in system memory. Surfaces allocated in video memory might require a larger stride, depending on the graphics card. </p><p> If you are working with a DirectX surface buffer, use the <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Lock2D(System.Byte[],System.Int32@)"/></strong> method to find the surface stride. </p><p> For planar YUV formats, this function returns the stride for the Y plane. Depending on the format, the chroma planes might have a different stride. </p><p><strong>Note</strong>??Prior to Windows?7, this function was exported from evr.dll. Starting in Windows?7, this function is exported from mfplat.dll, and evr.dll exports a stub function that calls into mfplat.dll. For more information, see Library Changes in Windows?7.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetStrideForBitmapInfoHeader']/*"/>
|
|
<msdn-id>aa473720</msdn-id>
|
|
<unmanaged>HRESULT MFGetStrideForBitmapInfoHeader([In] unsigned int format,[In] unsigned int dwWidth,[Out] int* pStride)</unmanaged>
|
|
<unmanaged-short>MFGetStrideForBitmapInfoHeader</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.HeapFree(System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="vRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFHeapFree']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>void MFHeapFree([In] void* pv)</unmanaged>
|
|
<unmanaged-short>MFHeapFree</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.HeapAlloc(System.Int32,System.Int32,System.String,System.Int32,SharpDX.MediaFoundation.EAllocationType)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="nSize"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="dwFlags"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="szFileRef">No documentation.</param>
|
|
<param name="line">No documentation.</param>
|
|
<param name="eat">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFHeapAlloc']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>void* MFHeapAlloc([In] unsigned int nSize,[In] unsigned int dwFlags,[In, Optional] char* pszFile,[In] int line,[In] EAllocationType eat)</unmanaged>
|
|
<unmanaged-short>MFHeapAlloc</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateCollection(SharpDX.MediaFoundation.Collection@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates an empty collection object.</p>
|
|
</summary>
|
|
<param name="iMFCollectionOut"><dd> <p>Receives a reference to the collection object's <strong><see cref="T:SharpDX.MediaFoundation.Collection"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateCollection']/*"/>
|
|
<msdn-id>ms698852</msdn-id>
|
|
<unmanaged>HRESULT MFCreateCollection([Out] IMFCollection** ppIMFCollection)</unmanaged>
|
|
<unmanaged-short>MFCreateCollection</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.RegisterLocalSchemeHandler(System.String,SharpDX.MediaFoundation.Activate)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Registers a scheme handler in the caller's process.</p>
|
|
</summary>
|
|
<param name="szScheme"><dd> <p>A string that contains the scheme. The scheme includes the trailing ':' character; for example, "http:".</p> </dd></param>
|
|
<param name="activateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface of an activation object. The caller implements this interface. The <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> method of the activation object must create a scheme handler object. The scheme handler exposes the <strong><see cref="T:SharpDX.MediaFoundation.SchemeHandler"/></strong> interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Scheme handlers are used in Microsoft Media Foundation during the source resolution process, which creates a media source from a URL. For more information, see Scheme Handlers and Byte-Stream Handlers.</p><p>Within a process, local scheme handlers take precedence over scheme handlers that are registered in the registry. Local scheme handlers are not visible to other processes.</p><p>Use this function if you want to register a custom scheme handler for your application, but do not want the handler available to other applications.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRegisterLocalSchemeHandler']/*"/>
|
|
<msdn-id>hh162787</msdn-id>
|
|
<unmanaged>HRESULT MFRegisterLocalSchemeHandler([In] const wchar_t* szScheme,[In] IMFActivate* pActivate)</unmanaged>
|
|
<unmanaged-short>MFRegisterLocalSchemeHandler</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoSampleAllocatorEx(System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates an object that allocates video samples that are compatible with Microsoft DirectX Graphics Infrastructure (DXGI).</p>
|
|
</summary>
|
|
<param name="riid"><dd> <p>The identifier of the interface to retrieve. Specify one of the following values.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><strong>IID_IUnknown</strong></strong></dt> </dl> </td><td> <p>Retrieve an <strong><see cref="T:SharpDX.ComObject"/></strong> reference.</p> </td></tr> <tr><td><dl> <dt><strong><strong>IID_IMFVideoSampleAllocator</strong></strong></dt> </dl> </td><td> <p>Retrieve an <strong><see cref="T:SharpDX.MediaFoundation.VideoSampleAllocator"/></strong> reference.</p> </td></tr> <tr><td><dl> <dt><strong><strong>IID_IMFVideoSampleAllocatorEx</strong></strong></dt> </dl> </td><td> <p>Retrieve an <strong><see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorEx"/></strong> reference.</p> </td></tr> <tr><td><dl> <dt><strong><strong>IID_IMFVideoSampleAllocatorCallback</strong></strong></dt> </dl> </td><td> <p>Retrieve an <strong><see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorCallback"/></strong> reference.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="sampleAllocatorOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function creates an allocator for DXGI video surfaces. The buffers created by this allocator expose the <strong><see cref="T:SharpDX.MediaFoundation.DXGIBuffer"/></strong> interface. To create an allocator for Microsoft Direct3D?9 video surfaces, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoSampleAllocator(System.Guid,System.IntPtr@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoSampleAllocatorEx']/*"/>
|
|
<msdn-id>hh162763</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoSampleAllocatorEx([In] const GUID& riid,[Out] void** ppSampleAllocator)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoSampleAllocatorEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.ScheduleWorkItem(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,System.Int64,System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Schedules an asynchronous operation to be completed after a specified interval.</p>
|
|
</summary>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface. The caller must implement this interface.</p> </dd></param>
|
|
<param name="stateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<param name="timeout"><dd> <p>Time-out interval, in milliseconds. Set this parameter to a negative value. The callback is invoked after ?<em>Timeout</em> milliseconds. For example, if <em>Timeout</em> is ?5000, the callback is invoked after 5000 milliseconds.</p> </dd></param>
|
|
<param name="keyRef"><dd> <p>Receives a key that can be used to cancel the timer. To cancel the timer, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CancelWorkItem(System.Int64)"/></strong> and pass this key in the <em>Key</em> parameter.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This function creates an asynchronous result object. When the timer interval elapses, the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method specified by <em>pCallback</em> is called.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFScheduleWorkItem']/*"/>
|
|
<msdn-id>ms703045</msdn-id>
|
|
<unmanaged>HRESULT MFScheduleWorkItem([In] IMFAsyncCallback* pCallback,[In] IUnknown* pState,[In] longlong Timeout,[Out, Optional] unsigned longlong* pKey)</unmanaged>
|
|
<unmanaged-short>MFScheduleWorkItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.RemovePeriodicCallback(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Cancels a callback function that was set by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AddPeriodicCallback(SharpDX.FunctionCallback,SharpDX.ComObject,System.Int32@)"/></strong> function.</p>
|
|
</summary>
|
|
<param name="dwKey">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The callback is dispatched on another thread, and this function does not attempt to synchronize with the callback thread. Therefore, it is possible for the callback to be invoked after this function returns.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRemovePeriodicCallback']/*"/>
|
|
<msdn-id>ms704741</msdn-id>
|
|
<unmanaged>HRESULT MFRemovePeriodicCallback([In] unsigned int dwKey)</unmanaged>
|
|
<unmanaged-short>MFRemovePeriodicCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocal(SharpDX.ComObject,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Registers a Media Foundation transform (MFT) in the caller's process.</p>
|
|
</summary>
|
|
<param name="classFactoryRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a class factory object. The class factory creates the MFT.</p> </dd></param>
|
|
<param name="guidCategory"><dd> <p>A <see cref="T:System.Guid"/> that specifies the category of the MFT. For a list of MFT categories, see <strong>MFT_CATEGORY</strong>.</p> </dd></param>
|
|
<param name="szNameRef"><dd> <p>A wide-character null-terminated string that contains the friendly name of the MFT.</p> </dd></param>
|
|
<param name="flags"><dd> <p>A bitwise <strong>OR</strong> of zero or more flags from the <strong>_MFT_ENUM_FLAG</strong> enumeration.</p> </dd></param>
|
|
<param name="cInputTypes"><dd> <p>The number of elements in the <em>pInputTypes</em> array.</p> </dd></param>
|
|
<param name="inputTypesRef"><dd> <p>A reference to an array of <strong><see cref="T:SharpDX.MediaFoundation.TRegisterTypeInformation"/></strong> structures. Each member of the array specifies an input format that the MFT supports. This parameter can be <strong><c>null</c></strong> if <em>cInputTypes</em> is zero.</p> </dd></param>
|
|
<param name="cOutputTypes"><dd> <p>The number of elements in the <em>pOutputTypes</em> array.</p> </dd></param>
|
|
<param name="outputTypesRef"><dd> <p>A reference to an array of <strong><see cref="T:SharpDX.MediaFoundation.TRegisterTypeInformation"/></strong> structures. Each member of the array defines an output format that the MFT supports. This parameter can be <strong><c>null</c></strong> if <em>cOutputTypes</em> is zero.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The primary purpose of this function is to make an MFT available for automatic topology resolution without making the MFT available to other processes or applications.</p><p>After you call this function, the MFT can be enumerated by calling the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> function with the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsLocalmft"/></strong> flag. The MFT can be enumerated from within the same process, but is not visible to other processes.</p><p>The <em>pClassFactory</em> parameter specifies a class factory object that creates the MFT. The class factory's <strong>IClassFactory::CreateInstance</strong> method must return an object that supports the <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> interface.</p><p><strong>Note</strong>??The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> function retrieves a list of <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> references. However, the class factory does not need to support the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface. Instead, the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> function provides an implementation of <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> that wraps the class factory.</p><p>To unregister the MFT from the current process, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TUnregisterLocal(SharpDX.ComObject)"/></strong>.</p><p>If you need to register an MFT in the Protected Media Path (PMP) process, use the <strong><see cref="T:SharpDX.MediaFoundation.LocalMFTRegistration"/></strong> interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTRegisterLocal']/*"/>
|
|
<msdn-id>dd388656</msdn-id>
|
|
<unmanaged>HRESULT MFTRegisterLocal([In] IClassFactory* pClassFactory,[In] const GUID& guidCategory,[In] const wchar_t* pszName,[In] unsigned int Flags,[In] unsigned int cInputTypes,[In, Buffer, Optional] const MFT_REGISTER_TYPE_INFO* pInputTypes,[In] unsigned int cOutputTypes,[In, Buffer, Optional] const MFT_REGISTER_TYPE_INFO* pOutputTypes)</unmanaged>
|
|
<unmanaged-short>MFTRegisterLocal</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetWorkQueueMMCSSClass(System.Int32,System.IntPtr,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="dwWorkQueueId"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="wszClassRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="cchClassRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetWorkQueueMMCSSClass']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFGetWorkQueueMMCSSClass([In] unsigned int dwWorkQueueId,[Out, Buffer, Optional] wchar_t* pwszClass,[InOut] unsigned int* pcchClass)</unmanaged>
|
|
<unmanaged-short>MFGetWorkQueueMMCSSClass</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetPlaneSize(System.Int32,System.Int32,System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="format"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="dwWidth"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="dwHeight">No documentation.</param>
|
|
<param name="dwPlaneSizeRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetPlaneSize']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFGetPlaneSize([In] unsigned int format,[In] unsigned int dwWidth,[In] unsigned int dwHeight,[Out] unsigned int* pdwPlaneSize)</unmanaged>
|
|
<unmanaged-short>MFGetPlaneSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.MapDX9FormatToDXGIFormat(System.Int32)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Converts a Microsoft Direct3D?9 format identifier to a Microsoft DirectX Graphics Infrastructure (DXGI) format identifier.</p>
|
|
</summary>
|
|
<param name="dx9"><dd> <p>The <strong>D3DFORMAT</strong> value or FOURCC code to convert.</p> </dd></param>
|
|
<returns><p>Returns a <strong><see cref="T:SharpDX.DXGI.Format"/></strong> value.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMapDX9FormatToDXGIFormat']/*"/>
|
|
<msdn-id>hh162772</msdn-id>
|
|
<unmanaged>DXGI_FORMAT MFMapDX9FormatToDXGIFormat([In] unsigned int dx9)</unmanaged>
|
|
<unmanaged-short>MFMapDX9FormatToDXGIFormat</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.Shutdown">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Shuts down the Microsoft Media Foundation platform. Call this function once for every call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. Do not call this function from work queue threads.</p>
|
|
</summary>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFShutdown']/*"/>
|
|
<msdn-id>ms694273</msdn-id>
|
|
<unmanaged>HRESULT MFShutdown()</unmanaged>
|
|
<unmanaged-short>MFShutdown</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.LockDXGIDeviceManager(System.Int32@,SharpDX.MediaFoundation.DXGIDeviceManager@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Unlocks the shared Microsoft DirectX Graphics Infrastructure (DXGI) Device Manager.</p>
|
|
</summary>
|
|
<param name="resetTokenRef">No documentation.</param>
|
|
<param name="managerOut">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call this function after a successful call to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockDXGIDeviceManager(System.Int32@,SharpDX.MediaFoundation.DXGIDeviceManager@)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFLockDXGIDeviceManager']/*"/>
|
|
<msdn-id>hh162800</msdn-id>
|
|
<unmanaged>HRESULT MFLockDXGIDeviceManager([Out, Optional] unsigned int* pResetToken,[Out] IMFDXGIDeviceManager** ppManager)</unmanaged>
|
|
<unmanaged-short>MFLockDXGIDeviceManager</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CalculateImageSize(System.Guid,System.Int32,System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="guidSubtype"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="unWidth"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="unHeight">No documentation.</param>
|
|
<param name="cbImageSizeRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCalculateImageSize']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCalculateImageSize([In] const GUID& guidSubtype,[In] unsigned int unWidth,[In] unsigned int unHeight,[Out] unsigned int* pcbImageSize)</unmanaged>
|
|
<unmanaged-short>MFCalculateImageSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetMFTMerit(SharpDX.ComObject,System.Int32,System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="mFTRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="cbVerifier"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="verifier">No documentation.</param>
|
|
<param name="merit">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetMFTMerit']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFGetMFTMerit([InOut] IUnknown* pMFT,[In] unsigned int cbVerifier,[In, Buffer] const unsigned char* verifier,[Out] unsigned int* merit)</unmanaged>
|
|
<unmanaged-short>MFGetMFTMerit</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateLegacyMediaBufferOnMFMediaBuffer(SharpDX.MediaFoundation.Sample,SharpDX.MediaFoundation.MediaBuffer,System.Int32,SharpDX.MediaFoundation.IMediaBuffer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="sampleRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="mFMediaBufferRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="cbOffset">No documentation.</param>
|
|
<param name="mediaBufferOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateLegacyMediaBufferOnMFMediaBuffer']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateLegacyMediaBufferOnMFMediaBuffer([In, Optional] IMFSample* pSample,[In] IMFMediaBuffer* pMFMediaBuffer,[In] unsigned int cbOffset,[Out] IMediaBuffer** ppMediaBuffer)</unmanaged>
|
|
<unmanaged-short>MFCreateLegacyMediaBufferOnMFMediaBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.WrapMediaType(SharpDX.MediaFoundation.MediaType,System.Guid,System.Guid,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates a media type that wraps another media type. </p>
|
|
</summary>
|
|
<param name="origRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type to wrap in a new media type. </p> </dd></param>
|
|
<param name="majorType"><dd> <p>A <see cref="T:System.Guid"/> that specifies the major type for the new media type. For a list of possible values, see Major Media Types. </p> </dd></param>
|
|
<param name="subType"><dd> <p>A <see cref="T:System.Guid"/> that specifies the subtype for the new media type. For possible values, see:</p> <ul> <li> <strong>Audio Subtypes</strong> </li> <li> Video Subtypes </li> </ul> <p>Applications can define custom subtype GUIDs.</p> </dd></param>
|
|
<param name="wrapOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the new media type that wraps the original media type. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> The original media type (<em>pOrig</em>) is stored in the new media type under the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.WrappedType"/></strong> attribute. To extract the original media type, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnwrapMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType@)"/></strong>. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFWrapMediaType']/*"/>
|
|
<msdn-id>ms701782</msdn-id>
|
|
<unmanaged>HRESULT MFWrapMediaType([In] IMFMediaType* pOrig,[In] const GUID& MajorType,[In] const GUID& SubType,[Out] IMFMediaType** ppWrap)</unmanaged>
|
|
<unmanaged-short>MFWrapMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetContentProtectionSystemCLSID(System.Guid,System.Guid@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Gets the class identifier for a content protection system.</p>
|
|
</summary>
|
|
<param name="guidProtectionSystemID"><dd> <p>The <see cref="T:System.Guid"/> that identifies the content protection system.</p> </dd></param>
|
|
<param name="clsidRef"><dd> <p>Receives the class identifier to the content protection system.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The class identifier can be used to create the input trust authority (ITA) for the content protection system. Call <strong>CoCreateInstance</strong> or <strong><see cref="M:SharpDX.MediaFoundation.PMPHost.CreateObjectByCLSID_(System.Guid,System.IntPtr,System.Guid,System.IntPtr)"/></strong> to get an <strong><see cref="T:SharpDX.MediaFoundation.TrustedInput"/></strong> reference.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetContentProtectionSystemCLSID']/*"/>
|
|
<msdn-id>hh162766</msdn-id>
|
|
<unmanaged>HRESULT MFGetContentProtectionSystemCLSID([In] const GUID& guidProtectionSystemID,[Out] GUID* pclsid)</unmanaged>
|
|
<unmanaged-short>MFGetContentProtectionSystemCLSID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.ValidateMediaTypeSize(System.Guid,System.Byte[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Validates the size of a buffer for a video format block. </p>
|
|
</summary>
|
|
<param name="formatType"><dd> <p><see cref="T:System.Guid"/> that specifies the type of format block. It must be one of the following values:</p> <dl> <dt><strong>FORMAT_DvInfo</strong></dt> <dt><strong>FORMAT_MFVideoFormat</strong></dt> <dt><strong>FORMAT_MPEG2Video</strong></dt> <dt><strong>FORMAT_MPEGStreams</strong></dt> <dt><strong>FORMAT_MPEGVideo</strong></dt> <dt><strong>FORMAT_VideoInfo</strong></dt> <dt><strong>FORMAT_VideoInfo2</strong></dt> <dt><strong>FORMAT_WaveFormatEx</strong></dt> </dl> </dd></param>
|
|
<param name="blockRef"><dd> <p> Pointer to a buffer that contains the format block. </p> </dd></param>
|
|
<param name="cbSize"><dd> <p> Size of the <em>pBlock</em> buffer, in bytes. </p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The buffer that contains the format block is large enough. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDMEDIATYPE</strong></dt> </dl> </td><td> <p> The buffer that contains the format block is too small, or the format block is not valid. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_FORMAT</strong></dt> </dl> </td><td> <p> This function does not support the specified format type. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFValidateMediaTypeSize']/*"/>
|
|
<msdn-id>ms698993</msdn-id>
|
|
<unmanaged>HRESULT MFValidateMediaTypeSize([In] GUID FormatType,[In, Buffer, Optional] unsigned char* pBlock,[In] unsigned int cbSize)</unmanaged>
|
|
<unmanaged-short>MFValidateMediaTypeSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateAlignedMemoryBuffer(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaBuffer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Allocates system memory with a specified byte alignment and creates a media buffer to manage the memory. </p>
|
|
</summary>
|
|
<param name="cbMaxLength"><dd> <p>Size of the buffer, in bytes.</p> </dd></param>
|
|
<param name="cbAligment"><dd> <p> Specifies the memory alignment for the buffer. Use one of the following constants. </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>MF_1_BYTE_ALIGNMENT</strong></dt> <dt>0x00000000</dt> </dl> </td><td> <p> Align to 1 bytes. </p> </td></tr> <tr><td><dl> <dt><strong>MF_2_BYTE_ALIGNMENT</strong></dt> <dt>0x00000001</dt> </dl> </td><td> <p> Align to 2 bytes. </p> </td></tr> <tr><td><dl> <dt><strong>MF_4_BYTE_ALIGNMENT</strong></dt> <dt>0x00000003</dt> </dl> </td><td> <p> Align to 4 bytes. </p> </td></tr> <tr><td><dl> <dt><strong>MF_8_BYTE_ALIGNMENT</strong></dt> <dt>0x00000007</dt> </dl> </td><td> <p> Align to 8 bytes. </p> </td></tr> <tr><td><dl> <dt><strong>MF_16_BYTE_ALIGNMENT</strong></dt> <dt>0x0000000F</dt> </dl> </td><td> <p> Align to 16 bytes. </p> </td></tr> <tr><td><dl> <dt><strong>MF_32_BYTE_ALIGNMENT</strong></dt> <dt>0x0000001F</dt> </dl> </td><td> <p> Align to 32 bytes. </p> </td></tr> <tr><td><dl> <dt><strong>MF_64_BYTE_ALIGNMENT</strong></dt> <dt>0x0000003F</dt> </dl> </td><td> <p> Align to 64 bytes. </p> </td></tr> <tr><td><dl> <dt><strong>MF_128_BYTE_ALIGNMENT</strong></dt> <dt>0x0000007F</dt> </dl> </td><td> <p> Align to 128 bytes. </p> </td></tr> <tr><td><dl> <dt><strong>MF_256_BYTE_ALIGNMENT</strong></dt> <dt>0x000000FF</dt> </dl> </td><td> <p> Align to 256 bytes. </p> </td></tr> <tr><td><dl> <dt><strong>MF_512_BYTE_ALIGNMENT</strong></dt> <dt>0x000001FF</dt> </dl> </td><td> <p> Align to 512 bytes. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="bufferOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface of the media buffer. The caller must release the interface. </p> </dd></param>
|
|
<returns><p> The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p> The function succeeded. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> When the media buffer object is destroyed, it releases the allocated memory. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateAlignedMemoryBuffer']/*"/>
|
|
<msdn-id>bb970523</msdn-id>
|
|
<unmanaged>HRESULT MFCreateAlignedMemoryBuffer([In] unsigned int cbMaxLength,[In] unsigned int cbAligment,[Out] IMFMediaBuffer** ppBuffer)</unmanaged>
|
|
<unmanaged-short>MFCreateAlignedMemoryBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.UnlockWorkQueue(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Unlocks a work queue.</p>
|
|
</summary>
|
|
<param name="dwWorkQueue"><dd> <p>Identifier for the work queue to be unlocked. The identifier is returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> function.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The application must call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockWorkQueue(System.Int32)"/></strong> once for every call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> and then once for every call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockWorkQueue(System.Int32)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFUnlockWorkQueue']/*"/>
|
|
<msdn-id>aa372543</msdn-id>
|
|
<unmanaged>HRESULT MFUnlockWorkQueue([In] unsigned int dwWorkQueue)</unmanaged>
|
|
<unmanaged-short>MFUnlockWorkQueue</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.LockPlatform">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Blocks the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> function.</p>
|
|
</summary>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This function prevents work queue threads from being shut down when <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> is called. Use this function to ensure that asynchronous operations complete gracefully before the platform shuts down.</p><p>This function holds a lock on the Media Foundation platform. To unlock the platform, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockPlatform"/></strong>. The application must call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockPlatform"/></strong> once for every call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockPlatform"/></strong>.</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> function blocks until the platform is unlocked, or until a fixed wait period has elapsed. (The wait period is a few seconds.) To avoid memory leaks, the application should unlock the platform before the wait period ends. For example, cancel any asynchronous operations that are waiting to complete and are holding a lock on the platform.</p><p>The default implementation of the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface automatically locks the Media Foundation platform when the result object is created. Releasing the interface unlocks the platform. Therefore, in most cases your application does not need to lock the platform directly. For more information, see Work Queues.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFLockPlatform']/*"/>
|
|
<msdn-id>ms693588</msdn-id>
|
|
<unmanaged>HRESULT MFLockPlatform()</unmanaged>
|
|
<unmanaged-short>MFLockPlatform</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMemoryBuffer(System.Int32,SharpDX.MediaFoundation.MediaBuffer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Allocates system memory and creates a media buffer to manage it.</p>
|
|
</summary>
|
|
<param name="cbMaxLength"><dd> <p>Size of the buffer, in bytes.</p> </dd></param>
|
|
<param name="bufferOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface of the media buffer. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_OUTOFMEMORY</strong></dt> </dl> </td><td> <p>Insufficient memory.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The function allocates a buffer with a 1-byte memory alignment. To allocate a buffer that is aligned to a larger memory boundary, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAlignedMemoryBuffer(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaBuffer@)"/></strong>.</p><p>When the media buffer object is destroyed, it releases the allocated memory.</p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMemoryBuffer']/*"/>
|
|
<msdn-id>ms695212</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMemoryBuffer([In] unsigned int cbMaxLength,[Out] IMFMediaBuffer** ppBuffer)</unmanaged>
|
|
<unmanaged-short>MFCreateMemoryBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.RegisterLocalByteStreamHandler(System.String,System.String,SharpDX.MediaFoundation.Activate)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Registers a byte-stream handler in the caller's process.</p>
|
|
</summary>
|
|
<param name="szFileExtension"><dd> <p>A string that contains the file name extension for this handler.</p> </dd></param>
|
|
<param name="szMimeType"><dd> <p>A string that contains the MIME type for this handler.</p> </dd></param>
|
|
<param name="activateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface of an activation object. The caller implements this interface. The <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> method of the activation object must create a byte-stream handler. The byte-stream handler exposes the <strong><see cref="T:SharpDX.MediaFoundation.ByteStreamHandler"/></strong> interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Byte-stream handlers are used in Microsoft Media Foundation during the source resolution process, which creates a media source from a URL. For more information, see Scheme Handlers and Byte-Stream Handlers.</p><p>Within a process, local byte-stream handlers take precedence over byte-stream handlers that are registered in the registry. Local byte-stream handlers are not visible to other processes.</p><p>Use this function if you want to register a custom byte-stream handler for your application, but do not want the handler available to other applications.</p><p>Either <em>szFileExtension</em> or <em>szMimeType</em> can be <strong><c>null</c></strong>; at least one must be non-<strong><c>null</c></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRegisterLocalByteStreamHandler']/*"/>
|
|
<msdn-id>hh162786</msdn-id>
|
|
<unmanaged>HRESULT MFRegisterLocalByteStreamHandler([In] const wchar_t* szFileExtension,[In] const wchar_t* szMimeType,[In] IMFActivate* pActivate)</unmanaged>
|
|
<unmanaged-short>MFRegisterLocalByteStreamHandler</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.UnregisterPlatformFromMMCSS">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Unregisters the Microsoft Media Foundation platform work queues from a Multimedia Class Scheduler Service (MMCSS) task.</p>
|
|
</summary>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFUnregisterPlatformFromMMCSS']/*"/>
|
|
<msdn-id>hh162801</msdn-id>
|
|
<unmanaged>HRESULT MFUnregisterPlatformFromMMCSS()</unmanaged>
|
|
<unmanaged-short>MFUnregisterPlatformFromMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.EndUnregisterWorkQueueWithMMCSS(SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFEndUnregisterWorkQueueWithMMCSS']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFEndUnregisterWorkQueueWithMMCSS([In] IMFAsyncResult* pResult)</unmanaged>
|
|
<unmanaged-short>MFEndUnregisterWorkQueueWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.TUnregisterLocal(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Unregisters one or more Media Foundation transforms (MFTs) from the caller's process.</p>
|
|
</summary>
|
|
<param name="classFactoryRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a class factory object. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>HRESULT_FROM_WIN32(<strong><see cref="F:SharpDX.Win32.ErrorCode.NotFound"/></strong>)</strong></dt> </dl> </td><td> <p>The MFT specified by the <em>pClassFactory</em> parameter was not registered in this process.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Use this function to unregister a local MFT that was previously registered through the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocal(SharpDX.ComObject,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong> function.</p><p>If the <em>pClassFactory</em> parameter is <strong><c>null</c></strong>, all local MFTs in the process are unregistered. Otherwise, the function unregisters the MFT associated with the class factory specified by the <em>pClassFactory</em> parameter. In that case, the <em>pClassFactory</em> parameter should equal a reference value that was previously passed to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocal(SharpDX.ComObject,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTUnregisterLocal']/*"/>
|
|
<msdn-id>dd388658</msdn-id>
|
|
<unmanaged>HRESULT MFTUnregisterLocal([In, Optional] IClassFactory* pClassFactory)</unmanaged>
|
|
<unmanaged-short>MFTUnregisterLocal</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaEvent(System.Int32,System.Guid,SharpDX.Result,System.Nullable{SharpDX.Win32.Variant},SharpDX.MediaFoundation.MediaEvent@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Creates a media event object.</p>
|
|
</summary>
|
|
<param name="met"><dd> <p>The event type. See <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetTypeInfo(System.Int32@)"/></strong>. For a list of event types, see Media Foundation Events.</p> </dd></param>
|
|
<param name="guidExtendedType"><dd> <p>The extended type. See <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetExtendedType(System.Guid@)"/></strong>. If the event type does not have an extended type, use the value GUID_NULL.</p> </dd></param>
|
|
<param name="hrStatus"><dd> <p>The event status. See <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetStatus(SharpDX.Result@)"/></strong> </p> </dd></param>
|
|
<param name="vValueRef"><dd> <p>The value associated with the event, if any. See <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetValue(SharpDX.Win32.Variant@)"/></strong>. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="eventOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaEvent"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMediaEvent']/*"/>
|
|
<msdn-id>ms697521</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMediaEvent([In] unsigned int met,[In] const GUID& guidExtendedType,[In] HRESULT hrStatus,[In, Optional] const PROPVARIANT* pvValue,[Out] IMFMediaEvent** ppEvent)</unmanaged>
|
|
<unmanaged-short>MFCreateMediaEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.InitVideoFormat(SharpDX.MediaFoundation.Videoformat@,SharpDX.MediaFoundation.StandardVideoFormat)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="videoFormatRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="type"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFInitVideoFormat']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFInitVideoFormat([In] MFVIDEOFORMAT* pVideoFormat,[In] MFStandardVideoFormat type)</unmanaged>
|
|
<unmanaged-short>MFInitVideoFormat</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.Create2DMediaBuffer(System.Int32,System.Int32,System.Int32,System.Boolean,SharpDX.MediaFoundation.MediaBuffer@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates a system-memory buffer object to hold 2D image data.</p>
|
|
</summary>
|
|
<param name="dwWidth"><dd> <p>Width of the image, in pixels. </p> </dd></param>
|
|
<param name="dwHeight"><dd> <p>Height of the image, in pixels.</p> </dd></param>
|
|
<param name="dwFourCC"><dd> <p>A <strong>FOURCC</strong> code or D3DFORMAT value that specifies the video format. If you have a video subtype <see cref="T:System.Guid"/>, you can use the first <strong>DWORD</strong> of the subtype. </p> </dd></param>
|
|
<param name="fBottomUp"><dd> <p>If <strong>TRUE,</strong> the buffer's <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.ContiguousCopyTo(System.Byte[],System.Int32)"/></strong> method copies the buffer into a bottom-up format. The bottom-up format is compatible with GDI for uncompressed RGB images. If this parameter is <strong><see cref="F:SharpDX.Result.False"/></strong>, the <strong>ContiguousCopyTo</strong> method copies the buffer into a top-down format, which is compatible with DirectX. </p> <p>For more information about top-down versus bottom-up images, see Image Stride. </p> </dd></param>
|
|
<param name="bufferOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface.</p> </dd></param>
|
|
<returns><p>This function can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDMEDIATYPE</strong></dt> </dl> </td><td> <p>Unrecognized video format.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The returned buffer object also exposes the <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D2"/></strong> interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreate2DMediaBuffer']/*"/>
|
|
<msdn-id>hh162746</msdn-id>
|
|
<unmanaged>HRESULT MFCreate2DMediaBuffer([In] unsigned int dwWidth,[In] unsigned int dwHeight,[In] unsigned int dwFourCC,[In] BOOL fBottomUp,[Out] IMFMediaBuffer** ppBuffer)</unmanaged>
|
|
<unmanaged-short>MFCreate2DMediaBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.LlMulDiv(System.Int64,System.Int64,System.Int64,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Calculates ((a * b) + d) / c, where each term is a 64-bit signed value.</p>
|
|
</summary>
|
|
<param name="a"><dd> <p>A multiplier.</p> </dd></param>
|
|
<param name="b"><dd> <p>Another multiplier.</p> </dd></param>
|
|
<param name="c"><dd> <p>The divisor.</p> </dd></param>
|
|
<param name="d"><dd> <p>The rounding factor.</p> </dd></param>
|
|
<returns><p>Returns the result of the calculation. If numeric overflow occurs, the function returns _I64_MAX (positive overflow) or LLONG_MIN (negative overflow). If Mfplat.dll cannot be loaded, the function returns _I64_MAX.</p></returns>
|
|
<remarks>
|
|
<p><strong>Note</strong>??A previous version of this topic described the parameters incorrectly. The divisor is <em>c</em> and the rounding factor is <em>d</em>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFllMulDiv']/*"/>
|
|
<msdn-id>dd388510</msdn-id>
|
|
<unmanaged>longlong MFllMulDiv([In] longlong a,[In] longlong b,[In] longlong c,[In] longlong d)</unmanaged>
|
|
<unmanaged-short>MFllMulDiv</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateDXGISurfaceBuffer(System.Guid,SharpDX.ComObject,System.Int32,System.Boolean,SharpDX.MediaFoundation.MediaBuffer@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates a media buffer to manage a Microsoft DirectX Graphics Infrastructure (DXGI) surface.</p>
|
|
</summary>
|
|
<param name="riid"><dd> <p> Identifies the type of DXGI surface. This value must be <strong>IID_ID3D11Texture2D</strong>. </p> </dd></param>
|
|
<param name="unkSurfaceRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the DXGI surface. </p> </dd></param>
|
|
<param name="uSubresourceIndex"><dd> <p>The zero-based index of a subresource of the surface. The media buffer object is associated with this subresource.</p> </dd></param>
|
|
<param name="fBottomUpWhenLinear"><dd> <p> If <strong>TRUE</strong>, the buffer's <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.ContiguousCopyTo(System.Byte[],System.Int32)"/></strong> method copies the buffer into a bottom-up format. The bottom-up format is compatible with GDI for uncompressed RGB images. If this parameter is <strong><see cref="F:SharpDX.Result.False"/></strong>, the <strong>ContiguousCopyTo</strong> method copies the buffer into a top-down format, which is compatible with Direct3D. </p> <p>For more information about top-down versus bottom-up images, see Image Stride.</p> </dd></param>
|
|
<param name="bufferOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface. The caller must release the buffer. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The returned buffer object supports the following interfaces:</p><ul> <li> <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> </li> <li> <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D2"/></strong> </li> <li> <strong><see cref="T:SharpDX.MediaFoundation.DXGIBuffer"/></strong> </li> <li> <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateDXGISurfaceBuffer']/*"/>
|
|
<msdn-id>hh162751</msdn-id>
|
|
<unmanaged>HRESULT MFCreateDXGISurfaceBuffer([In] const GUID& riid,[In] IUnknown* punkSurface,[In] unsigned int uSubresourceIndex,[In] BOOL fBottomUpWhenLinear,[Out] IMFMediaBuffer** ppBuffer)</unmanaged>
|
|
<unmanaged-short>MFCreateDXGISurfaceBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateFile(SharpDX.MediaFoundation.FileAccessmode,SharpDX.MediaFoundation.FileOpenmode,SharpDX.MediaFoundation.FileFlags,System.String,SharpDX.MediaFoundation.ByteStream@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates a byte stream from a file. </p>
|
|
</summary>
|
|
<param name="accessMode"><dd> <p> The requested access mode, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileAccessmode"/></strong> enumeration. </p> </dd></param>
|
|
<param name="openMode"><dd> <p> The behavior of the function if the file already exists or does not exist, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.FileOpenmode"/></strong> enumeration. </p> </dd></param>
|
|
<param name="fFlags"><dd> <p> Bitwise <strong>OR</strong> of values from the <strong><see cref="T:SharpDX.MediaFoundation.FileFlags"/></strong> enumeration. </p> </dd></param>
|
|
<param name="wszFileURLRef"><dd> <p> Pointer to a null-terminated string that contains the file name. </p> </dd></param>
|
|
<param name="iByteStreamOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of the byte stream. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateFile']/*"/>
|
|
<msdn-id>ms696166</msdn-id>
|
|
<unmanaged>HRESULT MFCreateFile([In] MF_FILE_ACCESSMODE AccessMode,[In] MF_FILE_OPENMODE OpenMode,[In] MF_FILE_FLAGS fFlags,[In] const wchar_t* pwszFileURL,[Out] IMFByteStream** ppIByteStream)</unmanaged>
|
|
<unmanaged-short>MFCreateFile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.InitMediaTypeFromMFVideoFormat(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.Videoformat[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="mFTypeRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="mFVFRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="cbBufSize">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFInitMediaTypeFromMFVideoFormat']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFInitMediaTypeFromMFVideoFormat([In] IMFMediaType* pMFType,[In, Buffer] const MFVIDEOFORMAT* pMFVF,[In] unsigned int cbBufSize)</unmanaged>
|
|
<unmanaged-short>MFInitMediaTypeFromMFVideoFormat</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaType(SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Creates an empty media type.</p>
|
|
</summary>
|
|
<param name="mFTypeOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> The media type is created without any attributes. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMediaType']/*"/>
|
|
<msdn-id>ms693861</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMediaType([Out] IMFMediaType** ppMFType)</unmanaged>
|
|
<unmanaged-short>MFCreateMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueueEx(SharpDX.MediaFoundation.AsyncWorkqueueType,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates a new work queue. This function extends the capabilities of the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> function by making it possible to create a work queue that has a message loop.</p>
|
|
</summary>
|
|
<param name="workQueueType">No documentation.</param>
|
|
<param name="dwWorkQueueRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_FAIL</strong></dt> </dl> </td><td> <p>The application exceeded the maximum number of work queues.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The application did not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>, or the application has already called <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong>.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When you are done using the work queue, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockWorkQueue(System.Int32)"/></strong>.</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> function is equivalent to calling <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueueEx(SharpDX.MediaFoundation.AsyncWorkqueueType,System.Int32@)"/></strong> with the value <see cref="F:SharpDX.MediaFoundation.AsyncWorkqueueType.MfStandardWorkqueue"/> for the <em>WorkQueueType</em> parameter.</p><p>This function is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAllocateWorkQueueEx']/*"/>
|
|
<msdn-id>dd375150</msdn-id>
|
|
<unmanaged>HRESULT MFAllocateWorkQueueEx([In] MFASYNC_WORKQUEUE_TYPE WorkQueueType,[Out] unsigned int* pdwWorkQueue)</unmanaged>
|
|
<unmanaged-short>MFAllocateWorkQueueEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItemEx2(System.Int32,System.Int32,SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Puts an asynchronous operation on a work queue, with a specified priority.</p>
|
|
</summary>
|
|
<param name="dwQueue"><dd> <p> The identifier for the work queue. This value can specify one of the standard Media Foundation work queues, or a work queue created by the application. For list of standard Media Foundation work queues, see <strong>Work Queue Identifiers</strong>. To create a new work queue, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueueEx(SharpDX.MediaFoundation.AsyncWorkqueueType,System.Int32@)"/></strong>.</p> </dd></param>
|
|
<param name="priority"><dd> <p>The priority of the work item. Work items are performed in order of priority.</p> </dd></param>
|
|
<param name="resultRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface of an asynchronous result object. To create the result object, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong>.</p> </dd></param>
|
|
<returns><p> Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include the following.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p> Success.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALID_WORKQUEUE</strong></strong></dt> </dl> </td><td> <p>Invalid work queue identifier.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> function was not called, or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> To invoke the work item, this function passes <em>pResult</em> to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.InvokeCallback(SharpDX.MediaFoundation.AsyncResult)"/></strong> function. The callback is specified when you create the result object specified by <em>pResult</em>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPutWorkItemEx2']/*"/>
|
|
<msdn-id>hh162785</msdn-id>
|
|
<unmanaged>HRESULT MFPutWorkItemEx2([In] unsigned int dwQueue,[In] int Priority,[In] IMFAsyncResult* pResult)</unmanaged>
|
|
<unmanaged-short>MFPutWorkItemEx2</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets a list of Microsoft Media Foundation transforms (MFTs) that match specified search criteria. This function extends the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnum(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.MediaAttributes,System.Guid[],System.Int32@)"/></strong> function.</p>
|
|
</summary>
|
|
<param name="guidCategory">No documentation.</param>
|
|
<param name="flags">No documentation.</param>
|
|
<param name="inputTypeRef">No documentation.</param>
|
|
<param name="outputTypeRef">No documentation.</param>
|
|
<param name="pMFTActivateOut">No documentation.</param>
|
|
<param name="numMFTActivateRef">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The <em>Flags</em> parameter controls which MFTs are enumerated, and the order in which they are returned. The flags for this parameter fall into several groups.</p><p> </p><p>The first set of flags specifies how an MFT processes data.</p><table> <tr><th>Flag</th><th>Description</th></tr> <tr><td> <p><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSyncmft"/></p> </td><td> <p>The MFT performs synchronous data processing in software. This is the original MFT processing model, and is compatible with Windows?Vista.</p> </td></tr> <tr><td> <p><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsAsyncmft"/></p> </td><td> <p>The MFT performs asynchronous data processing in software. This processing model requires Windows?7. For more information, see Asynchronous MFTs.</p> </td></tr> <tr><td> <p><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsHardware"/></p> </td><td> <p>The MFT performs hardware-based data processing, using either the AVStream driver or a GPU-based proxy MFT. MFTs in this category always process data asynchronously. For more information, see Hardware MFTs.</p> </td></tr> </table><p>?</p><p>Every MFT falls into exactly one of these categories. To enumerate a category, set the corresponding flag in the <em>Flags</em> parameter. You can combine these flags to enumerate more than one category. If none of these flags is specified, the default category is synchronous MFTs (<strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSyncmft"/></strong>).</p><p> </p><p> </p><p>Next, the following flags include MFTs that are otherwise excluded from the results. By default, flags that match these criteria are excluded from the results. Use any these flags to include them.</p><table> <tr><th>Flag</th><th>Description</th></tr> <tr><td> <p><strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsFieldofuse"/></strong></p> </td><td> <p>Include MFTs that must be unlocked by the application.</p> </td></tr> <tr><td> <p><strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsLocalmft"/></strong></p> </td><td> <p>Include MFTs that are registered in the caller's process through either the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocal(SharpDX.ComObject,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocalByCLSID(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong> function.</p> </td></tr> <tr><td> <p><strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsTranscodeOnly"/></strong></p> </td><td> <p>Include MFTs that are optimized for transcoding rather than playback.</p> </td></tr> </table><p>?</p><p> </p><p> </p><p>The last flag is used to sort and filter the results:</p><table> <tr><th>Flag</th><th>Description</th></tr> <tr><td> <p><strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSortandfilter"/></strong></p> </td><td> <p>Sort and filter the results.</p> </td></tr> </table><p>?</p><p>If the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSortandfilter"/></strong> flag is set, the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> function sorts the results as follows:</p><ul> <li>Local: If the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsLocalmft"/></strong> flag is set, local MFTs appear first in the list. To register a local MFT, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocal(SharpDX.ComObject,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocalByCLSID(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong> function.</li> <li>Merit: MFTs with a merit value appear next on the list, in order of merit value (highest to lowest). For more information about merit, see <see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftCodecMeritAttribute"/>. </li> <li>Preferred: If an MFT is listed in the plug-in control's preferred list, it appears next in the list. For more information about the plug-in control, see <strong><see cref="T:SharpDX.MediaFoundation.PluginControl"/></strong>.</li> <li>If an MFT appears on the blocked list, it is excluded from the results. For more information about the blocked list, see <strong><see cref="M:SharpDX.MediaFoundation.PluginControl.IsDisabled(System.Int32,System.Guid)"/></strong>.</li> <li>Any other MFTs that match the search criteria appear at the end of the list, unsorted.</li> </ul><p>If you do not set the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSortandfilter"/></strong> flag, the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> function returns an unsorted list.</p><p>Setting the <em>Flags</em> parameter to zero is equivalent to using the value <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSyncmft"/></strong> | <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsLocalmft"/></strong> | <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSortandfilter"/></strong>.</p><p>Setting <em>Flags</em> to <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSyncmft"/></strong> is equivalent to calling the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnum(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.MediaAttributes,System.Guid[],System.Int32@)"/></strong> function.</p><p>If no MFTs match the search criteria, the function returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>, unless some other error occurs. Therefore, always check the count received in the <em>pcMFTActivate</em> parameter before you dereference the <em>pppMFTActivate</em> reference.</p><p><strong>Note</strong>??There is no way to enumerate just local MFTs and nothing else. Setting <em>Flags</em> equal to <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsLocalmft"/></strong> is equivalent to including the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSyncmft"/></strong> flag. However, if you also sort the results by specifying the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsSortandfilter"/></strong> flag, local MFTs appear first in the list.</p>Creating the MFT<p>If at least one MFT matches the search criteria, the <em>pppMFTActivate</em> parameter receives an array of <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> references. One reference is returned for each matching MFT. Each reference represents an <em>activation object</em> for the MFT. For more information, see Activation Objects.</p><p>Additional information about each MFT is stored as attributes on the activation objects. For a list of the possible attributes, see Transform Attributes.</p><p>To create an instance of the MFT, call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong>.</p>Hardware Codecs<p>Hardware codecs are excluded from the enumeration results if the following registry keys are set to zero:</p><p>Decoders: </p><p><strong>HKEY_LOCAL_MACHINE</strong>\<strong>SOFTWARE</strong>\<strong>Microsoft</strong>\<strong>Windows Media Foundation</strong>\<strong>HardwareMFT</strong>\<strong>EnableDecoders</strong></p><p>Encoders: </p><p><strong>HKEY_LOCAL_MACHINE</strong>\<strong>SOFTWARE</strong>\<strong>Microsoft</strong>\<strong>Windows Media Foundation</strong>\<strong>HardwareMFT</strong>\<strong>EnableEncoders</strong></p><p>Video processors: </p><p><strong>HKEY_LOCAL_MACHINE</strong>\<strong>SOFTWARE</strong>\<strong>Microsoft</strong>\<strong>Windows Media Foundation</strong>\<strong>HardwareMFT</strong>\<strong>EnableVideoProcessors</strong></p><p>These keys are intended for OEMs, and should not be used by applications.</p><p>For hardware codecs, the <em>guidCategory</em> parameter of <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> can also specify one of the following kernel streaming (KS) device categories:</p><ul> <li><strong>KSCATEGORY_DATACOMPRESSOR</strong></li> <li><strong>KSCATEGORY_DATADECOMPRESSOR</strong></li> </ul><p>Hardware codecs should also be registered under an <strong>MFT_CATEGORY</strong> <see cref="T:System.Guid"/>, so applications should generally use those categories instead of the KS device categories.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTEnumEx']/*"/>
|
|
<msdn-id>dd388652</msdn-id>
|
|
<unmanaged>HRESULT MFTEnumEx([In] GUID guidCategory,[In] unsigned int Flags,[In, Optional] const MFT_REGISTER_TYPE_INFO* pInputType,[In, Optional] const MFT_REGISTER_TYPE_INFO* pOutputType,[Out, Buffer] IMFActivate*** pppMFTActivate,[Out] unsigned int* pnumMFTActivate)</unmanaged>
|
|
<unmanaged-short>MFTEnumEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreatePropertiesFromMediaType(SharpDX.MediaFoundation.MediaType,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="mediaTypeRef">No documentation.</param>
|
|
<param name="riid">No documentation.</param>
|
|
<param name="vOut">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='MFCreatePropertiesFromMediaType']/*"/>
|
|
<unmanaged>HRESULT MFCreatePropertiesFromMediaType([In] IMFMediaType* pMediaType,[In] const GUID& riid,[Out] void** ppv)</unmanaged>
|
|
<unmanaged-short>MFCreatePropertiesFromMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreatePresentationClock(SharpDX.MediaFoundation.PresentationClock@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="presentationClockOut"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreatePresentationClock']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreatePresentationClock([Out] IMFPresentationClock** ppPresentationClock)</unmanaged>
|
|
<unmanaged-short>MFCreatePresentationClock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSystemTimeSource(SharpDX.MediaFoundation.PresentationTimeSource@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates a presentation time source that is based on the system time.</p>
|
|
</summary>
|
|
<param name="systemTimeSourceOut"><dd> <p>Receives a reference to the object's <strong><see cref="T:SharpDX.MediaFoundation.PresentationTimeSource"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSystemTimeSource']/*"/>
|
|
<msdn-id>ms705610</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSystemTimeSource([Out] IMFPresentationTimeSource** ppSystemTimeSource)</unmanaged>
|
|
<unmanaged-short>MFCreateSystemTimeSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.EnumDeviceSources(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.Activate[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Enumerates a list of audio or video capture devices.</p>
|
|
</summary>
|
|
<param name="attributesRef"><dd> <p>Pointer to an attribute store that contains search criteria. To create the attribute store, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAttributes(SharpDX.MediaFoundation.MediaAttributes,System.Int32)"/></strong>. Set one or more of the following attributes on the attribute store:</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceType"/></strong></dt> </dl> </td><td> <p>Specifies whether to enumerate audio or video devices. (Required.)</p> </td></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeAudcapRole"/></strong></dt> </dl> </td><td> <p>For audio capture devices, specifies the device role. (Optional.)</p> </td></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapCategory"/></strong></dt> </dl> </td><td> <p>For video capture devices, specifies the device category. (Optional.)</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="pSourceActivateOut"><dd> <p>Receives an array of <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface references. Each reference represents an activation object for a media source. The function allocates the memory for the array. The caller must release the references in the array and call <strong>CoTaskMemFree</strong> to free the memory for the array.</p> </dd></param>
|
|
<param name="cSourceActivateRef"><dd> <p>Receives the number of elements in the <em>pppSourceActivate</em> array. If no capture devices match the search criteria, this parameter receives the value 0.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Each returned <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> reference represents a capture device, and can be used to create a media source for that device. You can also use the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> reference to query for attributes that describe the device. The following attributes might be set:</p><table> <tr><th>Attribute</th><th>Description</th></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.FriendlyName"/> </td><td>The display name of the device.</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.MediaType"/> </td><td>The major type and subtype GUIDs that describe the device's output format.</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceType"/> </td><td>The type of capture device (audio or video).</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeAudcapEndpointId"/> </td><td>The audio endpoint ID string. (Audio devices only.)</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapCategory"/> </td><td>The device category. (Video devices only.)</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapHwSource"/> </td><td> Whether a device is a hardware or software device. (Video devices only.)</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapSymbolicLink"/> </td><td>The symbolic link for the device driver. (Video devices only.)</td></tr> </table><p>?</p><p>To create a media source from an <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> reference, call the <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFEnumDeviceSources']/*"/>
|
|
<msdn-id>dd388503</msdn-id>
|
|
<unmanaged>HRESULT MFEnumDeviceSources([In] IMFAttributes* pAttributes,[Out, Buffer] IMFActivate*** pppSourceActivate,[Out] unsigned int* pcSourceActivate)</unmanaged>
|
|
<unmanaged-short>MFEnumDeviceSources</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeProfile(SharpDX.MediaFoundation.TranscodeProfile@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates an empty transcode profile object.</p><p>The transcode profile stores configuration settings for the output file. These configuration settings are specified by the caller, and include audio and video stream properties, encoder settings, and container settings. To set these properties, the caller must call the appropriate <strong><see cref="T:SharpDX.MediaFoundation.TranscodeProfile"/></strong> methods.</p><p>The configured transcode profile is passed to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeTopology(SharpDX.MediaFoundation.MediaSource,System.String,SharpDX.MediaFoundation.TranscodeProfile,SharpDX.MediaFoundation.Topology@)"/></strong> function. The underlying topology builder uses these settings to build the transcode topology.</p>
|
|
</summary>
|
|
<param name="transcodeProfileOut">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeProfile(SharpDX.MediaFoundation.TranscodeProfile@)"/></strong> function creates an empty transcode profile. You must configure the transcode profile setting attributes that define the media types and the container properties. Use the following methods to configure the profile:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.TranscodeProfile.SetAudioAttributes(SharpDX.MediaFoundation.MediaAttributes)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.TranscodeProfile.SetVideoAttributes(SharpDX.MediaFoundation.MediaAttributes)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.TranscodeProfile.SetContainerAttributes(SharpDX.MediaFoundation.MediaAttributes)"/></strong> </li> </ul><p>For example code that uses this function, see the following topics:</p><ul> <li> Tutorial: Encoding an MP4 File </li> <li> Tutorial: Encoding a WMA File </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateTranscodeProfile']/*"/>
|
|
<msdn-id>dd388113</msdn-id>
|
|
<unmanaged>HRESULT MFCreateTranscodeProfile([Out] IMFTranscodeProfile** ppTranscodeProfile)</unmanaged>
|
|
<unmanaged-short>MFCreateTranscodeProfile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateCredentialCache(SharpDX.MediaFoundation.NetCredentialCache@)">
|
|
<summary>
|
|
<p>Media Foundation provides a default implementation of the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialCache"/></strong> interface. An application that implements the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface can use the default credential cache object to store the user's credentials.</p><p>To create the default credential cache object, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateCredentialCache(SharpDX.MediaFoundation.NetCredentialCache@)"/></strong> function.</p><pre><code><see cref="T:SharpDX.Result"/> hr = <see cref="F:SharpDX.Result.Ok"/>;
|
|
<see cref="T:SharpDX.MediaFoundation.NetCredentialCache"/> *pCredentialCache = <c>null</c>;
|
|
hr = <see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateCredentialCache(SharpDX.MediaFoundation.NetCredentialCache@)"/>(&pCredentialCache);
|
|
</code></pre><p>After the credential cache is created, the application can use the following methods to get a credential object, set user credentials, and specify the caching options.</p><ul> <li> <p>To get the credential object for a URL, call <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.GetCredential(System.String,System.String,System.Int32,SharpDX.MediaFoundation.NetCredential@,System.Int32@)"/></strong>.</p> <pre><code>hr = pCredentialCache-> GetCredential( pszUrl, pszRealm, dwAuthenticationFlags, &pCredential, &dwRequirementsFlags);
|
|
</code></pre> <p>If the credentials for the specified URL do not exist in the credential cache, <strong>GetCredential</strong> creates a new credential object with empty user name and password values.</p> </li> <li> To set the user name and password on the credential object, call <strong><see cref="M:SharpDX.MediaFoundation.NetCredential.SetUser(System.Byte[],System.Int32,System.Boolean)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.NetCredential.SetPassword(System.Byte[],System.Int32,System.Boolean)"/></strong>. </li> <li> <p>To set the caching options on the credential object, call <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)"/></strong>.</p> <pre><code>hr = pCredentialCache-> SetUserOptions( pCredentialCache, <see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialSave"/>);
|
|
</code></pre> <p>The <em>dwOptionsFlags</em> parameter values are defined in the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialOptions"/></strong> enumeration. To save user credentials for a URL in a persistent storage, set the <see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialSave"/> flag. If the <strong>SetUserOptions</strong> call completes successfully, then the subsequent call to <strong>GetCredential</strong> searches for the credentials in the persistent storage. If a match is found, this method returns a reference to the credential object that contains the information.</p> <p>By default, user credentials sent over the network are encrypted. To change this to clear text, set the <see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialAllowClearText"/> flag.</p> <p>To remove information from the registry, call <strong>GetCredential</strong> to get the credential object, and then call <strong>SetUserOption</strong> and set <em>dwOptionsFlags</em> to <see cref="F:SharpDX.MediaFoundation.NetCredentialOptions.MfnetCredentialDontCache"/>.</p> </li> </ul>
|
|
</summary>
|
|
<param name="cacheOut">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='MFCreateCredentialCache']/*"/>
|
|
<msdn-id>ee318418</msdn-id>
|
|
<unmanaged>HRESULT MFCreateCredentialCache([Out] IMFNetCredentialCache** ppCache)</unmanaged>
|
|
<unmanaged-short>MFCreateCredentialCache</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMFByteStreamOnStream(System.IntPtr,SharpDX.MediaFoundation.ByteStream@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates a Microsoft Media Foundation byte stream that wraps an <strong><see cref="T:SharpDX.Win32.IStream"/></strong> reference.</p>
|
|
</summary>
|
|
<param name="streamRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.Win32.IStream"/></strong> interface.</p> </dd></param>
|
|
<param name="byteStreamOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value.</p></returns>
|
|
<remarks>
|
|
<p>This function enables applications to pass an <strong><see cref="T:SharpDX.Win32.IStream"/></strong> object to a Media Foundation API that takes an <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> reference.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMFByteStreamOnStream']/*"/>
|
|
<msdn-id>dd388095</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMFByteStreamOnStream([In] IStream* pStream,[Out] IMFByteStream** ppByteStream)</unmanaged>
|
|
<unmanaged-short>MFCreateMFByteStreamOnStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateFMPEG4MediaSink(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="iByteStreamRef">No documentation.</param>
|
|
<param name="videoMediaTypeRef">No documentation.</param>
|
|
<param name="audioMediaTypeRef">No documentation.</param>
|
|
<param name="iMediaSinkOut">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='MFCreateFMPEG4MediaSink']/*"/>
|
|
<unmanaged>HRESULT MFCreateFMPEG4MediaSink([In] IMFByteStream* pIByteStream,[In, Optional] IMFMediaType* pVideoMediaType,[In, Optional] IMFMediaType* pAudioMediaType,[Out] IMFMediaSink** ppIMediaSink)</unmanaged>
|
|
<unmanaged-short>MFCreateFMPEG4MediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateProxyLocator(System.String,SharpDX.ComObject,SharpDX.MediaFoundation.NetProxyLocator@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="szProtocolRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="proxyConfigRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="proxyLocatorOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateProxyLocator']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateProxyLocator([In] const wchar_t* pszProtocol,[In] IPropertyStore* pProxyConfig,[Out] IMFNetProxyLocator** ppProxyLocator)</unmanaged>
|
|
<unmanaged-short>MFCreateProxyLocator</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSampleGrabberSinkActivate(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.SampleGrabberSinkCallback,SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates an activation object for the sample grabber media sink.</p>
|
|
</summary>
|
|
<param name="iMFMediaTypeRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface, defining the media type for the sample grabber's input stream. </p> </dd></param>
|
|
<param name="iMFSampleGrabberSinkCallbackRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback"/></strong> interface of a callback object. The caller must implement this interface. </p> </dd></param>
|
|
<param name="iActivateOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface. Use this interface to complete the creation of the sample grabber. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To create the sample grabber sink, call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> on the reference received in the <em>ppIActivate</em> parameter.</p><p>Before calling <strong>ActivateObject</strong>, you can configure the sample grabber by setting any of the following attributes on the <em>ppIActivate</em> reference:</p><ul> <li> <see cref="F:SharpDX.MediaFoundation.SampleGrabberSinkAttributeKeys.IgnoreClock"/> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.SampleGrabberSinkAttributeKeys.SampleTimeOffset"/></strong> </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSampleGrabberSinkActivate']/*"/>
|
|
<msdn-id>ms702068</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSampleGrabberSinkActivate([In] IMFMediaType* pIMFMediaType,[In] IMFSampleGrabberSinkCallback* pIMFSampleGrabberSinkCallback,[Out] IMFActivate** ppIActivate)</unmanaged>
|
|
<unmanaged-short>MFCreateSampleGrabberSinkActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMPEG4MediaSink(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates a media sink for authoring MP4 files.</p>
|
|
</summary>
|
|
<param name="iByteStreamRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of a byte stream. The media sink writes the MP4 file to this byte stream. The byte stream must be writable and support seeking.</p> </dd></param>
|
|
<param name="videoMediaTypeRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of a video media type. This type specifies the format of the video stream.</p> <p>This parameter can be <strong><c>null</c></strong>, but not if <em>pAudioMediaType</em> is <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="audioMediaTypeRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of an audio media type. This type specifies the format of the audio stream.</p> <p>This parameter can be <strong><c>null</c></strong>, but not if <em>pVideoMediaType</em> is <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="iMediaSinkOut"><dd> <p>Receives a reference to the MP4 media sink's <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The MP4 media sink supports a maximum of one video stream and one audio stream. The initial stream formats are given in the <em>pVideoMediaType</em> and <em>pAudioMediaType</em> parameters. To create an MP4 file with one stream, set the other stream type to <strong><c>null</c></strong>. For example, to create an audio-only file, set <em>pVideoMediaType</em> to <strong><c>null</c></strong>. </p><p>The number of streams is fixed when you create the media sink. The sink does not support the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong> method.</p><p>To author 3GP files, use the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Create3GPMediaSink(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaSink@)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMPEG4MediaSink']/*"/>
|
|
<msdn-id>dd388100</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMPEG4MediaSink([In] IMFByteStream* pIByteStream,[In, Optional] IMFMediaType* pVideoMediaType,[In, Optional] IMFMediaType* pAudioMediaType,[Out] IMFMediaSink** ppIMediaSink)</unmanaged>
|
|
<unmanaged-short>MFCreateMPEG4MediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.LoadSignedLibrary(System.String,SharpDX.MediaFoundation.SignedLibrary@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates the source resolver, which is used to create a media source from a URL or byte stream. </p>
|
|
</summary>
|
|
<param name="szNameRef"><dd> <p>Receives a reference to the source resolver's <strong><see cref="T:SharpDX.MediaFoundation.SourceResolver"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<param name="libOut">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p><strong>Note</strong>??Prior to Windows?7, this function was exported from mf.dll. Starting in Windows?7, this function is exported from mfplat.dll, and mf.dll exports a stub function that calls into mfplat.dll. For more information, see Library Changes in Windows?7.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFLoadSignedLibrary']/*"/>
|
|
<msdn-id>ms697433</msdn-id>
|
|
<unmanaged>HRESULT MFLoadSignedLibrary([In] const wchar_t* pszName,[Out] IMFSignedLibrary** ppLib)</unmanaged>
|
|
<unmanaged-short>MFLoadSignedLibrary</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeSinkActivate(SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates the transcode sink activation object.</p><p>The transcode sink activation object can be used to create any of the following file sinks:</p><ul> <li>3GP file sink</li> <li>MP3 file sink</li> <li>MP4 file sink</li> </ul><p>The transcode sink activation object exposes the <strong><see cref="T:SharpDX.MediaFoundation.TranscodeSinkInfoProvider"/></strong> interface.</p>
|
|
</summary>
|
|
<param name="activateOut">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateTranscodeSinkActivate']/*"/>
|
|
<msdn-id>dd388115</msdn-id>
|
|
<unmanaged>HRESULT MFCreateTranscodeSinkActivate([Out] IMFActivate** ppActivate)</unmanaged>
|
|
<unmanaged-short>MFCreateTranscodeSinkActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetService(SharpDX.ComObject,System.Guid,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Queries an object for a specified service interface.</p><p>This function is a helper function that wraps the <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> method. The function queries the object for the <strong><see cref="T:SharpDX.MediaFoundation.ServiceProvider"/></strong> interface and, if successful, calls <strong>GetService</strong> on the object.</p>
|
|
</summary>
|
|
<param name="unkObjectRef">No documentation.</param>
|
|
<param name="guidService">No documentation.</param>
|
|
<param name="riid">No documentation.</param>
|
|
<param name="vObjectOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_SERVICE</strong></dt> </dl> </td><td> <p> The service requested cannot be found in the object represented by <em>punkObject</em>. </p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetService']/*"/>
|
|
<msdn-id>ms694284</msdn-id>
|
|
<unmanaged>HRESULT MFGetService([In] IUnknown* punkObject,[In] const GUID& guidService,[In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
|
|
<unmanaged-short>MFGetService</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMuxSink(System.Guid,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Creates a generic media sink that wraps a multiplexer Microsoft Media Foundation transform (MFT).</p>
|
|
</summary>
|
|
<param name="guidOutputSubType"><dd> <p>The subtype <see cref="T:System.Guid"/> of the output type for the MFT.</p> </dd></param>
|
|
<param name="outputAttributesRef"><dd> <p>A list of format attributes for the MFT output type. This parameter is optional and can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="outputByteStreamRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of a byte stream. The output from the MFT is written to this byte stream. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="muxSinkOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface of the media sink. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function attempts to find a multiplexer MFT that supports an output type with the following definition:</p><ul> <li>Major type: <strong>MFMediaType_Stream</strong></li> <li>Subtype: <em>guidOutputSubType</em></li> <li>Additional format attributes (optional)</li> </ul><p>To provide a list of additional format attributes:</p><ol> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAttributes(SharpDX.MediaFoundation.MediaAttributes,System.Int32)"/></strong> to get an <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> reference.</li> <li>Use the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface to set the attributes. (See Media Type Attributes.)</li> <li>Pass the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> reference in the <em>pOutputAttributes</em> parameter.</li> </ol><p>The multiplexer MFT must be registered in the <strong>MFT_CATEGORY_MULTIPLEXER</strong> category.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMuxSink']/*"/>
|
|
<msdn-id>hh162756</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMuxSink([In] GUID guidOutputSubType,[In, Optional] IMFAttributes* pOutputAttributes,[In, Optional] IMFByteStream* pOutputByteStream,[Out] IMFMediaSink** ppMuxSink)</unmanaged>
|
|
<unmanaged-short>MFCreateMuxSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetSupportedMimeTypes(SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="propVarMimeTypeArrayRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetSupportedMimeTypes']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFGetSupportedMimeTypes([Out] PROPVARIANT* pPropVarMimeTypeArray)</unmanaged>
|
|
<unmanaged-short>MFGetSupportedMimeTypes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.Create3GPMediaSink(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates a media sink for authoring 3GP files.</p>
|
|
</summary>
|
|
<param name="iByteStreamRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of a byte stream. The media sink writes the 3GP file to this byte stream. The byte stream must be writable and support seeking.</p> </dd></param>
|
|
<param name="videoMediaTypeRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of a video media type. This type specifies the format of the video stream.</p> <p>This parameter can be <strong><c>null</c></strong>, but not if <em>pAudioMediaType</em> is <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="audioMediaTypeRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of an audio media type. This type specifies the format of the audio stream.</p> <p>This parameter can be <strong><c>null</c></strong>, but not if <em>pVideoMediaType</em> is <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="iMediaSinkOut"><dd> <p>Receives a reference to the 3GP media sink's <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The 3GP media sink supports a maximum of one video stream and one audio stream. The initial stream formats are given in the <em>pVideoMediaType</em> and <em>pAudioMediaType</em> parameters. To create an MP4 file with one stream, set the other stream type to <strong><c>null</c></strong>. For example, to create an audio-only file, set <em>pVideoMediaType</em> to <strong><c>null</c></strong>. </p><p>The number of streams is fixed when you create the media sink. The sink does not support the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong> method.</p><p>To author MP4 files, use the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMPEG4MediaSink(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaSink@)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreate3GPMediaSink']/*"/>
|
|
<msdn-id>dd388084</msdn-id>
|
|
<unmanaged>HRESULT MFCreate3GPMediaSink([In] IMFByteStream* pIByteStream,[In, Optional] IMFMediaType* pVideoMediaType,[In, Optional] IMFMediaType* pAudioMediaType,[Out] IMFMediaSink** ppIMediaSink)</unmanaged>
|
|
<unmanaged-short>MFCreate3GPMediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeTopology(SharpDX.MediaFoundation.MediaSource,System.String,SharpDX.MediaFoundation.TranscodeProfile,SharpDX.MediaFoundation.Topology@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates a partial transcode topology.</p><p>The underlying topology builder creates a partial topology by connecting the required pipeline objects:
|
|
source, encoder, and sink. The encoder and the sink are configured according to the settings specified by the caller in the transcode profile. </p><p>To create the transcode profile object, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeProfile(SharpDX.MediaFoundation.TranscodeProfile@)"/></strong> function and set the required attributes by calling the appropriate the <strong><see cref="T:SharpDX.MediaFoundation.TranscodeProfile"/></strong> methods. </p><p>The configured transcode profile is passed to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeTopology(SharpDX.MediaFoundation.MediaSource,System.String,SharpDX.MediaFoundation.TranscodeProfile,SharpDX.MediaFoundation.Topology@)"/></strong> function, which creates the transcode topology with the appropriate settings. The caller can then set this topology on the Media Session and start the session to begin the encoding process. When the Media Session ends, the transcoded file is generated.</p>
|
|
</summary>
|
|
<param name="srcRef">No documentation.</param>
|
|
<param name="wszOutputFilePathRef">No documentation.</param>
|
|
<param name="profileRef">No documentation.</param>
|
|
<param name="transcodeTopoOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function call succeeded, and <em>ppTranscodeTopo</em> receives a reference to the transcode topology.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>pwszOutputFilePath</em> contains invalid characters.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_MEDIA_SOURCE_NO_STREAMS_SELECTED</strong></dt> </dl> </td><td> <p>No streams are selected in the media source.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSCODE_NO_CONTAINERTYPE</strong></dt> </dl> </td><td> <p>The profile does not contain the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSCODE_NO_MATCHING_ENCODER</strong></dt> </dl> </td><td> <p>For one or more streams, cannot find an encoder that accepts the media type given in the profile.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSCODE_PROFILE_NO_MATCHING_STREAMS</strong></dt> </dl> </td><td> <p>The profile does not specify a media type for any of the selected streams on the media source.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For example code that uses this function, see the following topics:</p><ul> <li> Tutorial: Encoding an MP4 File </li> <li> Tutorial: Encoding a WMA File </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateTranscodeTopology']/*"/>
|
|
<msdn-id>dd388118</msdn-id>
|
|
<unmanaged>HRESULT MFCreateTranscodeTopology([In] IMFMediaSource* pSrc,[In] const wchar_t* pwszOutputFilePath,[In] IMFTranscodeProfile* pProfile,[Out] IMFTopology** ppTranscodeTopo)</unmanaged>
|
|
<unmanaged-short>MFCreateTranscodeTopology</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.TranscodeGetAudioOutputAvailableTypes(System.Guid,System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.Collection@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets a list of output formats from an audio encoder.</p>
|
|
</summary>
|
|
<param name="guidSubType"><dd> <p>Specifies the subtype of the output media. The encoder uses this value as a filter when it is enumerating the available output types. For information about the audio subtypes, see <strong>Audio Subtype GUIDs</strong>. </p> </dd></param>
|
|
<param name="dwMFTFlags"><dd> <p>Bitwise <strong>OR</strong> of zero or more flags from the <strong>_MFT_ENUM_FLAG</strong> enumeration. </p> </dd></param>
|
|
<param name="codecConfigRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of an attribute store. The attribute store specifies the encoder configuration settings. This parameter can be <strong><c>null</c></strong>. The attribute store can hold any of the following attributes.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftFieldofuseUnlockAttribute"/></strong></dt> </dl> </td><td> <p>Set this attribute to unlock an encoder that has field-of-use descriptions.</p> </td></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeEncodingprofile"/></strong></dt> </dl> </td><td> <p>Specifies a device conformance profile for a Windows Media encoder.</p> </td></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeQualityvsspeed"/></strong></dt> </dl> </td><td> <p>Sets the tradeoff between encoding quality and encoding speed.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="availableTypesOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Collection"/></strong> interface of a collection object that contains a list of preferred audio media types. The collection contains <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> references. The caller must release the interface reference.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function call succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSCODE_NO_MATCHING_ENCODER</strong></dt> </dl> </td><td> <p>Failed to find an encoder that matches the specified configuration settings.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This function assumes the encoder will be used in its default encoding mode, which is typically constant bit-rate (CBR) encoding. Therefore, the types returned by the function might not work with other modes, such as variable bit-rate (VBR) encoding.</p><p>Internally, this function works by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> to find a matching encoder, and then calling <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputAvailableType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType@)"/></strong> to get the encoder's output types.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTranscodeGetAudioOutputAvailableTypes']/*"/>
|
|
<msdn-id>dd388655</msdn-id>
|
|
<unmanaged>HRESULT MFTranscodeGetAudioOutputAvailableTypes([In] const GUID& guidSubType,[In] unsigned int dwMFTFlags,[In, Optional] IMFAttributes* pCodecConfig,[Out] IMFCollection** ppAvailableTypes)</unmanaged>
|
|
<unmanaged-short>MFTranscodeGetAudioOutputAvailableTypes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSimpleTypeHandler(SharpDX.MediaFoundation.MediaTypeHandler@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="handlerOut"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSimpleTypeHandler']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSimpleTypeHandler([Out] IMFMediaTypeHandler** ppHandler)</unmanaged>
|
|
<unmanaged-short>MFCreateSimpleTypeHandler</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateNetSchemePlugin(System.Guid,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates the scheme handler for the network source.</p>
|
|
</summary>
|
|
<param name="riid"><dd> <p>Interface identifier (IID) of the interface to retrieve.</p> </dd></param>
|
|
<param name="vHandlerOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface. The scheme handler exposes the <strong><see cref="T:SharpDX.MediaFoundation.SchemeHandler"/></strong> interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateNetSchemePlugin']/*"/>
|
|
<msdn-id>aa378396</msdn-id>
|
|
<unmanaged>HRESULT MFCreateNetSchemePlugin([In] const GUID& riid,[In] void** ppvHandler)</unmanaged>
|
|
<unmanaged-short>MFCreateNetSchemePlugin</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateAC3MediaSink(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Creates an instance of the AC-3 media sink.</p>
|
|
</summary>
|
|
<param name="targetByteStreamRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of a byte stream. The media sink writes the AC-3 file to this byte stream. The byte stream must be writable. </p> </dd></param>
|
|
<param name="audioMediaTypeRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. This parameter specifies the media type for the AC-3 audio stream. The media type must contain the following attributes.</p> <table> <tr><th>Attribute</th><th>Value</th></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.MajorType"/> </td><td><strong>MFMediaType_Audio</strong></td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Subtype"/> </td><td><strong>MFAudioFormat_Dolby_AC3</strong> or <strong>MFAudioFormat_Dolby_DDPlus</strong></td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="mediaSinkOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The AC-3 media sink takes compressed AC-3 audio as input and writes the audio to the byte stream without modification. The primary use for this media sink is to stream AC-3 audio over a network. The media sink does not perform AC-3 audio encoding.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateAC3MediaSink']/*"/>
|
|
<msdn-id>hh162747</msdn-id>
|
|
<unmanaged>HRESULT MFCreateAC3MediaSink([In] IMFByteStream* pTargetByteStream,[In] IMFMediaType* pAudioMediaType,[Out] IMFMediaSink** ppMediaSink)</unmanaged>
|
|
<unmanaged-short>MFCreateAC3MediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates an instance of the Media Session inside a Protected Media Path (PMP) process. </p>
|
|
</summary>
|
|
<param name="dwCreationFlags">No documentation.</param>
|
|
<param name="configurationRef">No documentation.</param>
|
|
<param name="mediaSessionOut">No documentation.</param>
|
|
<param name="enablerActivateOut">No documentation.</param>
|
|
<returns><p> The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You can use the <em>pConfiguration</em> parameter to set any of the following attributes:</p><ul> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.ContentProtectionManager"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.GlobalTime"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.QualityManager"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.RemoteSourceMode"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.ServerContext"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.Topoloader"/></strong> </li> </ul><p>If this function cannot create the PMP Media Session because a trusted binary was revoked, the <em>ppEnablerActivate</em> parameter receives an <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface reference. The application can use this reference to create a content enabler object, which can then be used to download an updated binary:</p><ol> <li> Call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> with the interface identifier IID_IMFContentEnabler to get an <strong><see cref="T:SharpDX.MediaFoundation.ContentEnabler"/></strong> interface reference. </li> <li> Use that interface to download the updated binary. </li> <li> Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong> again. </li> </ol><p>If the function successfully creates the PMP Media Session, the <em>ppEnablerActivate</em> parameter receives the value <strong><c>null</c></strong>.</p><p>Do not make calls to the PMP Media Session from a thread that is processing a window message sent from another thread. To test whether the current thread falls into this category, call <strong>InSendMessage</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreatePMPMediaSession']/*"/>
|
|
<msdn-id>ms703144</msdn-id>
|
|
<unmanaged>HRESULT MFCreatePMPMediaSession([In] unsigned int dwCreationFlags,[In] IMFAttributes* pConfiguration,[Out] IMFMediaSession** ppMediaSession,[Out, Optional] IMFActivate** ppEnablerActivate)</unmanaged>
|
|
<unmanaged-short>MFCreatePMPMediaSession</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreatePropertyStore(SharpDX.ComObject@)">
|
|
<summary>
|
|
<p>[This API is not supported and may be altered or unavailable in the future. Instead, applications should use the <strong>PSCreateMemoryPropertyStore</strong> function to create property stores.]</p><p><strong>Applies to: </strong>desktop apps only</p><p> Creates an empty property store object.</p>
|
|
</summary>
|
|
<param name="storeOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='CreatePropertyStore']/*"/>
|
|
<msdn-id>ms702984</msdn-id>
|
|
<unmanaged>HRESULT CreatePropertyStore([Out] IPropertyStore** ppStore)</unmanaged>
|
|
<unmanaged-short>CreatePropertyStore</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateAudioRendererActivate(SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates an activation object for the Streaming Audio Renderer.</p>
|
|
</summary>
|
|
<param name="activateOut">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To create the audio renderer, call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> on the retrieved <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> reference.</p><p><strong>Note</strong>??To avoid a memory leak, call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ShutdownObject"/></strong> before releasing the final reference to the audio renderer or the audio renderer activate object.</p><p>To configure the audio renderer, set any of the following attributes on the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> object before calling <strong>ActivateObject</strong>. (If you are using the Media Session, the Media Session automatically calls <strong>ActivateObject</strong> when you queue the topology.)</p><table> <tr><th>Attribute</th><th>Description</th></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.EndpointId"/></strong> </td><td>The audio endpoint device identifier.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.EndpointRole"/></strong> </td><td>The audio endpoint role.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.Flags"/></strong> </td><td>Miscellaneous configuration flags.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.SessionId"/></strong> </td><td>The audio policy class.</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.StreamCategory"/> </td><td>The audio stream category.</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.LowLatency"/> </td><td>Enables low-latency audio streaming.</td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateAudioRendererActivate']/*"/>
|
|
<msdn-id>ms702998</msdn-id>
|
|
<unmanaged>HRESULT MFCreateAudioRendererActivate([Out] IMFActivate** ppActivate)</unmanaged>
|
|
<unmanaged-short>MFCreateAudioRendererActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateTrackedSample(SharpDX.MediaFoundation.TrackedSample@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates an <strong><see cref="T:SharpDX.MediaFoundation.TrackedSample"/></strong> object that tracks the reference counts on a video media sample.</p>
|
|
</summary>
|
|
<param name="mFSampleOut">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='MFCreateTrackedSample']/*"/>
|
|
<msdn-id>hh162761</msdn-id>
|
|
<unmanaged>HRESULT MFCreateTrackedSample([Out] IMFTrackedSample** ppMFSample)</unmanaged>
|
|
<unmanaged-short>MFCreateTrackedSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateDeviceSource(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSource@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates a media source for a hardware capture device.</p>
|
|
</summary>
|
|
<param name="attributesRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of an attribute store, which is used to select the device. See Remarks.</p> </dd></param>
|
|
<param name="sourceOut"><dd> <p>Receives a reference to the media source's <strong><see cref="T:SharpDX.MediaFoundation.MediaSource"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The <em>pAttributes</em> parameter specifies an attribute store. To create the attribute store, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAttributes(SharpDX.MediaFoundation.MediaAttributes,System.Int32)"/></strong> function. You must set the <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceType"/> attribute, which specifies the type of device (audio or video).</p><p>For audio capture devices, optionally set one of the following attributes:</p><p></p><table> <tr><th>Attribute</th><th>Description</th></tr> <tr><td> <p> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeAudcapEndpointId"/> </p> </td><td> <p>Specifies the audio endpoint ID of the audio capture device.</p> </td></tr> <tr><td> <p> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeAudcapRole"/> </p> </td><td> <p>Specifies the device role. If this attribute is set, the function uses the default audio capture device for that device role.</p> <p>Do not combine this attribute with the <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeAudcapEndpointId"/> attribute.</p> </td></tr> </table><p>?</p><p>If neither attribute is specified, the function selects the default audio capture device for the <strong>eCommunications</strong> role.</p><p>For video capture devices, you must set the following attribute:</p><p></p><table> <tr><th>Attribute</th><th>Description</th></tr> <tr><td> <p> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapSymbolicLink"/> </p> </td><td> <p>Specifies the symbolic link to the device.</p> </td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateDeviceSource']/*"/>
|
|
<msdn-id>dd388091</msdn-id>
|
|
<unmanaged>HRESULT MFCreateDeviceSource([In] IMFAttributes* pAttributes,[Out] IMFMediaSource** ppSource)</unmanaged>
|
|
<unmanaged-short>MFCreateDeviceSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateADTSMediaSink(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Creates an instance of the audio data transport stream (ADTS) media sink.</p>
|
|
</summary>
|
|
<param name="targetByteStreamRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of a byte stream. The media sink writes the ADTS stream to this byte stream. The byte stream must be writable.</p> </dd></param>
|
|
<param name="audioMediaTypeRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. This parameter specifies the media type for the ADTS stream. The media type must contain the following attributes.</p> <table> <tr><th>Attribute</th><th>Value</th></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.MajorType"/> </td><td><strong>MFMediaType_Audio</strong></td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Subtype"/> </td><td><strong>MFAudioFormat_AAC</strong></td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AacPayloadType"/> </td><td>0 (raw AAC) or 1 (ADTS)</td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="mediaSinkOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The ADTS media sink converts Advanced Audio Coding (AAC) audio packets into an ADTS stream. The primary use for this media sink is to stream ADTS over a network. The output is not an audio file, but a stream of audio frames with ADTS headers.</p><p>The media sink can accept raw AAC frames (<see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AacPayloadType"/> = 0) or ADTS packets (<see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AacPayloadType"/> = 1). If the input is raw AAC, the media sink inserts an ADTS header at the start of each audio frame. If the input is ADTS packets, the media sink passes the packets through to the byte stream, without modification.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateADTSMediaSink']/*"/>
|
|
<msdn-id>hh162748</msdn-id>
|
|
<unmanaged>HRESULT MFCreateADTSMediaSink([In] IMFByteStream* pTargetByteStream,[In] IMFMediaType* pAudioMediaType,[Out] IMFMediaSink** ppMediaSink)</unmanaged>
|
|
<unmanaged-short>MFCreateADTSMediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.RequireProtectedEnvironment(SharpDX.MediaFoundation.PresentationDescriptor)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Queries whether a media presentation requires the Protected Media Path (PMP).</p>
|
|
</summary>
|
|
<param name="presentationDescriptorRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/></strong> interface of a presentation descriptor. The presentation descriptor is created by the media source, and describes the presentation.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>This presentation requires a protected environment.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>S_FALSE</strong></strong></dt> </dl> </td><td> <p>This presentation does not require a protected environment.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If this function returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>, it means the PMP is required for this presentation. Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong> to create the PMP session object.</p><p>If the function returns <strong>S_FALSE</strong>, you can use the unprotected pipeline. Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaSession(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@)"/></strong> to create the regular Media Session object.</p><p>Internally, this function checks whether any of the stream descriptors in the presentation have the <strong><see cref="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.Protected"/></strong> attribute with the value <strong>TRUE</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRequireProtectedEnvironment']/*"/>
|
|
<msdn-id>ms697052</msdn-id>
|
|
<unmanaged>HRESULT MFRequireProtectedEnvironment([In] IMFPresentationDescriptor* pPresentationDescriptor)</unmanaged>
|
|
<unmanaged-short>MFRequireProtectedEnvironment</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreatePresentationDescriptor(System.Int32,SharpDX.MediaFoundation.StreamDescriptor[],SharpDX.MediaFoundation.PresentationDescriptor@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Creates a presentation descriptor.</p>
|
|
</summary>
|
|
<param name="cStreamDescriptors"><dd> <p>Number of elements in the <em>apStreamDescriptors</em> array.</p> </dd></param>
|
|
<param name="apStreamDescriptors"><dd> <p>Array of <strong><see cref="T:SharpDX.MediaFoundation.StreamDescriptor"/></strong> interface references. Each reference represents a stream descriptor for one stream in the presentation.</p> </dd></param>
|
|
<param name="presentationDescriptorOut"><dd> <p>Receives a reference to an <strong><see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/></strong> interface of the presentation descriptor. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> If you are writing a custom media source, you can use this function to create the source presentation descriptor. The presentation descriptor is created with no streams selected. Generally, a media source should select at least one stream by default. To select a stream, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.SelectStream(System.Int32)"/></strong>. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreatePresentationDescriptor']/*"/>
|
|
<msdn-id>ms695404</msdn-id>
|
|
<unmanaged>HRESULT MFCreatePresentationDescriptor([In] unsigned int cStreamDescriptors,[In, Buffer, Optional] IMFStreamDescriptor** apStreamDescriptors,[Out] IMFPresentationDescriptor** ppPresentationDescriptor)</unmanaged>
|
|
<unmanaged-short>MFCreatePresentationDescriptor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSequencerSegmentOffset(System.Int32,System.Int64,SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="dwId"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="hnsOffset"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="varSegmentOffsetRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSequencerSegmentOffset']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSequencerSegmentOffset([In] unsigned int dwId,[In] longlong hnsOffset,[Out] PROPVARIANT* pvarSegmentOffset)</unmanaged>
|
|
<unmanaged-short>MFCreateSequencerSegmentOffset</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSampleCopierMFT(SharpDX.MediaFoundation.Transform@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates an instance of the sample copier transform.</p>
|
|
</summary>
|
|
<param name="copierMFTOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The sample copier is a Media Foundation transform (MFT) that copies data from input samples to output samples without modifying the data. The following data is copied from the sample:</p><ul> <li>All Sample Attributes.</li> <li>The time stamp and duration.</li> <li>Sample flags (see <strong><see cref="M:SharpDX.MediaFoundation.Sample.SetSampleFlags(System.Int32)"/></strong>).</li> <li>The data in the media buffers. If the input sample contains multiple buffers, the data is copied into a single buffer on the output sample.</li> </ul><p>This MFT is useful in the following situation:</p><ul> <li>One pipeline object, such as a media source, allocates media samples for output.</li> <li>Another pipeline object, such as a media sink, allocates its own media samples for input. For example, the object might require buffers allocated from a special memory pool, such as video memory.</li> </ul><p>The following diagram shows this situation with a media source and a media sink.</p><p></p><p>In order for the media sink to receive data from the media source, the data must be copied into the media samples owned by the media sink. The sample copier can be used for this purpose.</p><p>A specific example of such a media sink is the Enhanced Video Renderer (EVR). The EVR allocates samples that contain Direct3D surface buffers, so it cannot receive video samples directly from a media source. Starting in Windows?7, the topology loader automatically handles this case by inserting the sample copier between the media source and the EVR.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSampleCopierMFT']/*"/>
|
|
<msdn-id>dd388101</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSampleCopierMFT([Out] IMFTransform** ppCopierMFT)</unmanaged>
|
|
<unmanaged-short>MFCreateSampleCopierMFT</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMFByteStreamOnStreamEx(SharpDX.ComObject,SharpDX.MediaFoundation.ByteStream@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates a Microsoft Media Foundation byte stream that wraps an <strong>IRandomAccessStream</strong> object.</p>
|
|
</summary>
|
|
<param name="unkStreamRef">No documentation.</param>
|
|
<param name="byteStreamOut">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMFByteStreamOnStreamEx']/*"/>
|
|
<msdn-id>hh162754</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMFByteStreamOnStreamEx([In] IUnknown* punkStream,[Out] IMFByteStream** ppByteStream)</unmanaged>
|
|
<unmanaged-short>MFCreateMFByteStreamOnStreamEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateTopologyNode(SharpDX.MediaFoundation.TopologyType,SharpDX.MediaFoundation.TopologyNode@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates a topology node.</p>
|
|
</summary>
|
|
<param name="nodeType"><dd> <p> The type of node to create, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.TopologyType"/></strong> enumeration.</p> </dd></param>
|
|
<param name="nodeOut"><dd> <p> Receives a reference to the node's <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateTopologyNode']/*"/>
|
|
<msdn-id>ms697574</msdn-id>
|
|
<unmanaged>HRESULT MFCreateTopologyNode([In] MF_TOPOLOGY_TYPE NodeType,[Out] IMFTopologyNode** ppNode)</unmanaged>
|
|
<unmanaged-short>MFCreateTopologyNode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSourceResolver(SharpDX.MediaFoundation.SourceResolver@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates the source resolver, which is used to create a media source from a URL or byte stream. </p>
|
|
</summary>
|
|
<param name="iSourceResolverOut"><dd> <p>Receives a reference to the source resolver's <strong><see cref="T:SharpDX.MediaFoundation.SourceResolver"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p><strong>Note</strong>??Prior to Windows?7, this function was exported from mf.dll. Starting in Windows?7, this function is exported from mfplat.dll, and mf.dll exports a stub function that calls into mfplat.dll. For more information, see Library Changes in Windows?7.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSourceResolver']/*"/>
|
|
<msdn-id>ms697433</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSourceResolver([Out] IMFSourceResolver** ppISourceResolver)</unmanaged>
|
|
<unmanaged-short>MFCreateSourceResolver</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaTypeFromProperties(SharpDX.ComObject,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="unkStreamRef">No documentation.</param>
|
|
<param name="mediaTypeOut">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='MFCreateMediaTypeFromProperties']/*"/>
|
|
<unmanaged>HRESULT MFCreateMediaTypeFromProperties([In] IUnknown* punkStream,[Out] IMFMediaType** ppMediaType)</unmanaged>
|
|
<unmanaged-short>MFCreateMediaTypeFromProperties</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateTopology(SharpDX.MediaFoundation.Topology@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates a topology object.</p>
|
|
</summary>
|
|
<param name="topoOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface of the topology object. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateTopology']/*"/>
|
|
<msdn-id>ms701584</msdn-id>
|
|
<unmanaged>HRESULT MFCreateTopology([Out] IMFTopology** ppTopo)</unmanaged>
|
|
<unmanaged-short>MFCreateTopology</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetTopoNodeCurrentType(SharpDX.MediaFoundation.TopologyNode,System.Int32,System.Boolean,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="nodeRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="dwStreamIndex"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="fOutput">No documentation.</param>
|
|
<param name="typeOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetTopoNodeCurrentType']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFGetTopoNodeCurrentType([In] IMFTopologyNode* pNode,[In] unsigned int dwStreamIndex,[In] BOOL fOutput,[Out] IMFMediaType** ppType)</unmanaged>
|
|
<unmanaged-short>MFGetTopoNodeCurrentType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.ShutdownObject(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="unkRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFShutdownObject']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFShutdownObject([In] IUnknown* pUnk)</unmanaged>
|
|
<unmanaged-short>MFShutdownObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateRemoteDesktopPlugin(SharpDX.MediaFoundation.RemoteDesktopPlugin@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates the remote desktop plug-in object. Use this object if the application is running in a Terminal Services client session.</p>
|
|
</summary>
|
|
<param name="pluginOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.RemoteDesktopPlugin"/></strong> interface of the plug-in object. The caller must release the interface.</p> </dd></param>
|
|
<returns><p> The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The function succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_ACCESSDENIED</strong></dt> </dl> </td><td> <p>Remote desktop connections are not allowed by the current session policy.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateRemoteDesktopPlugin']/*"/>
|
|
<msdn-id>ms703133</msdn-id>
|
|
<unmanaged>HRESULT MFCreateRemoteDesktopPlugin([Out] IMFRemoteDesktopPlugin** ppPlugin)</unmanaged>
|
|
<unmanaged-short>MFCreateRemoteDesktopPlugin</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateTopoLoader(SharpDX.MediaFoundation.TopoLoader@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates a new instance of the topology loader.</p>
|
|
</summary>
|
|
<param name="objOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.TopoLoader"/></strong> interface of the topology loader. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateTopoLoader']/*"/>
|
|
<msdn-id>ms694159</msdn-id>
|
|
<unmanaged>HRESULT MFCreateTopoLoader([Out] IMFTopoLoader** ppObj)</unmanaged>
|
|
<unmanaged-short>MFCreateTopoLoader</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateStreamOnMFByteStream(SharpDX.MediaFoundation.ByteStream,SharpDX.Win32.IStream@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Returns an <strong><see cref="T:SharpDX.Win32.IStream"/></strong> reference that wraps a Microsoft Media Foundation byte stream.</p>
|
|
</summary>
|
|
<param name="byteStreamRef">No documentation.</param>
|
|
<param name="streamOut">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function enables an application to pass a Media Foundation byte stream to an API that takes an <strong><see cref="T:SharpDX.Win32.IStream"/></strong> reference.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateStreamOnMFByteStream']/*"/>
|
|
<msdn-id>hh162759</msdn-id>
|
|
<unmanaged>HRESULT MFCreateStreamOnMFByteStream([In] IMFByteStream* pByteStream,[Out] IStream** ppStream)</unmanaged>
|
|
<unmanaged-short>MFCreateStreamOnMFByteStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetSupportedSchemes(SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Enumerates a list of audio or video capture devices.</p>
|
|
</summary>
|
|
<param name="propVarSchemeArrayRef"><dd> <p>Pointer to an attribute store that contains search criteria. To create the attribute store, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAttributes(SharpDX.MediaFoundation.MediaAttributes,System.Int32)"/></strong>. Set one or more of the following attributes on the attribute store:</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceType"/></strong></dt> </dl> </td><td> <p>Specifies whether to enumerate audio or video devices. (Required.)</p> </td></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeAudcapRole"/></strong></dt> </dl> </td><td> <p>For audio capture devices, specifies the device role. (Optional.)</p> </td></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapCategory"/></strong></dt> </dl> </td><td> <p>For video capture devices, specifies the device category. (Optional.)</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Each returned <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> reference represents a capture device, and can be used to create a media source for that device. You can also use the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> reference to query for attributes that describe the device. The following attributes might be set:</p><table> <tr><th>Attribute</th><th>Description</th></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.FriendlyName"/> </td><td>The display name of the device.</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.MediaType"/> </td><td>The major type and subtype GUIDs that describe the device's output format.</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceType"/> </td><td>The type of capture device (audio or video).</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeAudcapEndpointId"/> </td><td>The audio endpoint ID string. (Audio devices only.)</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapCategory"/> </td><td>The device category. (Video devices only.)</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapHwSource"/> </td><td> Whether a device is a hardware or software device. (Video devices only.)</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.CaptureDeviceAttributeKeys.SourceTypeVidcapSymbolicLink"/> </td><td>The symbolic link for the device driver. (Video devices only.)</td></tr> </table><p>?</p><p>To create a media source from an <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> reference, call the <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetSupportedSchemes']/*"/>
|
|
<msdn-id>dd388503</msdn-id>
|
|
<unmanaged>HRESULT MFGetSupportedSchemes([Out] PROPVARIANT* pPropVarSchemeArray)</unmanaged>
|
|
<unmanaged-short>MFGetSupportedSchemes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetSystemTime">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Returns the system time. </p>
|
|
</summary>
|
|
<returns><p> Returns the system time, in 100-nanosecond units. </p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFGetSystemTime']/*"/>
|
|
<msdn-id>ms704625</msdn-id>
|
|
<unmanaged>longlong MFGetSystemTime()</unmanaged>
|
|
<unmanaged-short>MFGetSystemTime</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateDeviceSourceActivate(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="attributesRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="activateOut"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateDeviceSourceActivate']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateDeviceSourceActivate([In] IMFAttributes* pAttributes,[Out] IMFActivate** ppActivate)</unmanaged>
|
|
<unmanaged-short>MFCreateDeviceSourceActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateStreamDescriptor(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType[],SharpDX.MediaFoundation.StreamDescriptor@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates a stream descriptor. </p>
|
|
</summary>
|
|
<param name="dwStreamIdentifier"><dd> <p> Stream identifier. </p> </dd></param>
|
|
<param name="cMediaTypes"><dd> <p> Number of elements in the <em>apMediaTypes</em> array. </p> </dd></param>
|
|
<param name="apMediaTypes"><dd> <p> Pointer to an array of <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface references. These references are used to initialize the media type handler for the stream descriptor. </p> </dd></param>
|
|
<param name="descriptorOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.StreamDescriptor"/></strong> interface of the new stream descriptor. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> If you are writing a custom media source, you can use this function to create stream descriptors for the source. This function automatically creates the stream descriptor media type handler and initializes it with the list of types given in <em>apMediaTypes</em>. The function does not set the current media type on the handler, however. To set the type, call <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.SetCurrentMediaType(SharpDX.MediaFoundation.MediaType)"/></strong>. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateStreamDescriptor']/*"/>
|
|
<msdn-id>ms698990</msdn-id>
|
|
<unmanaged>HRESULT MFCreateStreamDescriptor([In] unsigned int dwStreamIdentifier,[In] unsigned int cMediaTypes,[In, Buffer] IMFMediaType** apMediaTypes,[Out] IMFStreamDescriptor** ppDescriptor)</unmanaged>
|
|
<unmanaged-short>MFCreateStreamDescriptor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.DeserializePresentationDescriptor(System.Int32,System.Byte[],SharpDX.MediaFoundation.PresentationDescriptor@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="cbData"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="bDataRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="pDOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFDeserializePresentationDescriptor']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFDeserializePresentationDescriptor([In] unsigned int cbData,[In, Buffer] unsigned char* pbData,[Out] IMFPresentationDescriptor** ppPD)</unmanaged>
|
|
<unmanaged-short>MFDeserializePresentationDescriptor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateProtectedEnvironmentAccess(SharpDX.MediaFoundation.ProtectedEnvironmentAccess@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates an <strong><see cref="T:SharpDX.MediaFoundation.ProtectedEnvironmentAccess"/></strong> object that allows content protection systems to perform a handshake with the protected environment.</p>
|
|
</summary>
|
|
<param name="accessOut">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='MFCreateProtectedEnvironmentAccess']/*"/>
|
|
<msdn-id>hh162758</msdn-id>
|
|
<unmanaged>HRESULT MFCreateProtectedEnvironmentAccess([Out] IMFProtectedEnvironmentAccess** ppAccess)</unmanaged>
|
|
<unmanaged-short>MFCreateProtectedEnvironmentAccess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateNamedPropertyStore(SharpDX.ComObject@)">
|
|
<summary>
|
|
<p>[This API is not supported and may be altered or unavailable in the future. Instead, applications should use the <strong>PSCreateMemoryPropertyStore</strong> function to create named property stores.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Creates an empty property store to hold name/value pairs.</p>
|
|
</summary>
|
|
<param name="storeOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='CreateNamedPropertyStore']/*"/>
|
|
<msdn-id>aa367379</msdn-id>
|
|
<unmanaged>HRESULT CreateNamedPropertyStore([Out] INamedPropertyStore** ppStore)</unmanaged>
|
|
<unmanaged-short>CreateNamedPropertyStore</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoRendererActivate(System.IntPtr,SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates an activation object for the enhanced video renderer (EVR) media sink.</p>
|
|
</summary>
|
|
<param name="hwndVideo"><dd> <p>Handle to the window where the video will be displayed.</p> </dd></param>
|
|
<param name="activateOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface. Use this interface to create the EVR. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To create the EVR, call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> on the retrieved <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> reference. (If you are using the Media Session, the Media Session automatically calls <strong>ActivateObject</strong> when you queue the topology.)</p><p>To configure the EVR, set any of the following attributes on the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> object before calling <strong>ActivateObject</strong>.</p><table> <tr><th>Attribute</th><th>Description</th></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.MixerActivate"/></strong> </td><td>Activation object for a custom mixer.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.MixerClsid"/></strong> </td><td>CLSID for a custom mixer.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.MixerFlags"/></strong> </td><td>Flags for creating a custom mixer.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.PresenterActivate"/></strong> </td><td>Activation object for a custom presenter.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.PresenterClsid"/></strong> </td><td>CLSID for a custom presenter.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.EVRCustomVideoAttributeKeys.PresenterFlags"/></strong> </td><td>Flags for creating a custom presenter.</td></tr> </table><p>?</p><p>When <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> is called, the activation objects sets the video window on the EVR by calling <strong><see cref="M:SharpDX.MediaFoundation.VideoDisplayControl.SetVideoPosition(System.Nullable{SharpDX.MediaFoundation.VideoNormalizedRect},System.Nullable{SharpDX.Rectangle})"/></strong>. Passing <strong><c>null</c></strong> for the <em>hwndVideo</em> parameter is not an error, but no video will render unless the EVR has a valid video window.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateVideoRendererActivate']/*"/>
|
|
<msdn-id>ms693543</msdn-id>
|
|
<unmanaged>HRESULT MFCreateVideoRendererActivate([In] HWND hwndVideo,[Out] IMFActivate** ppActivate)</unmanaged>
|
|
<unmanaged-short>MFCreateVideoRendererActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaSession(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates the Media Session in the application's process.</p>
|
|
</summary>
|
|
<param name="configurationRef">No documentation.</param>
|
|
<param name="mediaSessionOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The function succeeded. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If your application does not play protected content, you can use this function to create the Media Session in the application's process. To use the Media Session for protected content, you must call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong>. </p><p> You can use the <em>pConfiguration</em> parameter to specify any of the following attributes: </p><ul> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.GlobalTime"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.QualityManager"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.Topoloader"/></strong> </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMediaSession']/*"/>
|
|
<msdn-id>ms700174</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMediaSession([In] IMFAttributes* pConfiguration,[Out] IMFMediaSession** ppMediaSession)</unmanaged>
|
|
<unmanaged-short>MFCreateMediaSession</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateAggregateSource(SharpDX.MediaFoundation.Collection,SharpDX.MediaFoundation.MediaSource@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates a media source that aggregates a collection of media sources. </p>
|
|
</summary>
|
|
<param name="sourceCollectionRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Collection"/></strong> interface of the collection object that contains a list of media sources. </p> </dd></param>
|
|
<param name="aggSourceOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSource"/></strong> interface of the aggregated media source. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> The <em>pSourceCollection</em> collection does not contain any elements.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The aggregated media source is useful for combining streams from separate media sources. For example, you can use it to combine a video capture source and an audio capture source. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateAggregateSource']/*"/>
|
|
<msdn-id>dd388085</msdn-id>
|
|
<unmanaged>HRESULT MFCreateAggregateSource([In] IMFCollection* pSourceCollection,[Out] IMFMediaSource** ppAggSource)</unmanaged>
|
|
<unmanaged-short>MFCreateAggregateSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetSystemId(SharpDX.MediaFoundation.SystemId@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Returns an <strong><see cref="T:SharpDX.MediaFoundation.SystemId"/></strong> object for retrieving system id data.</p>
|
|
</summary>
|
|
<param name="idOut">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='MFGetSystemId']/*"/>
|
|
<msdn-id>hh162767</msdn-id>
|
|
<unmanaged>HRESULT MFGetSystemId([Out] IMFSystemId** ppId)</unmanaged>
|
|
<unmanaged-short>MFGetSystemId</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateStreamOnMFByteStreamEx(SharpDX.MediaFoundation.ByteStream,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="byteStreamRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="riid"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="vOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateStreamOnMFByteStreamEx']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateStreamOnMFByteStreamEx([In] IMFByteStream* pByteStream,[In] const GUID& riid,[Out] void** ppv)</unmanaged>
|
|
<unmanaged-short>MFCreateStreamOnMFByteStreamEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPServer(System.Int32,SharpDX.MediaFoundation.PMPServer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates the protected media path (PMP) server object.</p>
|
|
</summary>
|
|
<param name="dwCreationFlags"><dd> <p>A member of the <strong><see cref="T:SharpDX.MediaFoundation.PmpsessionCreationFlags"/></strong> enumeration that specifies how to create the PMP session.</p> </dd></param>
|
|
<param name="pMPServerOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.PMPServer"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The function succeeded. </p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreatePMPServer']/*"/>
|
|
<msdn-id>ms696183</msdn-id>
|
|
<unmanaged>HRESULT MFCreatePMPServer([In] unsigned int dwCreationFlags,[Out] IMFPMPServer** ppPMPServer)</unmanaged>
|
|
<unmanaged-short>MFCreatePMPServer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.GetLocalId(System.Byte[],System.Int32,System.IntPtr)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="verifier">No documentation.</param>
|
|
<param name="size">No documentation.</param>
|
|
<param name="id">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='MFGetLocalId']/*"/>
|
|
<unmanaged>HRESULT MFGetLocalId([In, Buffer] const unsigned char* verifier,[In] unsigned int size,[Out] wchar_t** id)</unmanaged>
|
|
<unmanaged-short>MFGetLocalId</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSequencerSource(SharpDX.ComObject,SharpDX.MediaFoundation.SequencerSource@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates the sequencer source.</p>
|
|
</summary>
|
|
<param name="reservedRef"><dd> <p>Reserved. Must be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="sequencerSourceOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.SequencerSource"/></strong> interface of the sequencer source. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSequencerSource']/*"/>
|
|
<msdn-id>ms704663</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSequencerSource([In] IUnknown* pReserved,[Out] IMFSequencerSource** ppSequencerSource)</unmanaged>
|
|
<unmanaged-short>MFCreateSequencerSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeTopologyFromByteStream(SharpDX.MediaFoundation.MediaSource,SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.TranscodeProfile,SharpDX.MediaFoundation.Topology@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="srcRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="outputStreamRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="profileRef">No documentation.</param>
|
|
<param name="transcodeTopoOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateTranscodeTopologyFromByteStream']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateTranscodeTopologyFromByteStream([In] IMFMediaSource* pSrc,[In] IMFByteStream* pOutputStream,[In] IMFTranscodeProfile* pProfile,[Out] IMFTopology** ppTranscodeTopo)</unmanaged>
|
|
<unmanaged-short>MFCreateTranscodeTopologyFromByteStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.SerializePresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor,System.Int32@,System.Byte[])">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="pDRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="cbDataRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="bDataOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSerializePresentationDescriptor']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFSerializePresentationDescriptor([In] IMFPresentationDescriptor* pPD,[Out] unsigned int* pcbData,[Out, Buffer] unsigned char** ppbData)</unmanaged>
|
|
<unmanaged-short>MFSerializePresentationDescriptor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateStandardQualityManager(SharpDX.MediaFoundation.QualityManager@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="qualityManagerOut"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateStandardQualityManager']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateStandardQualityManager([Out] IMFQualityManager** ppQualityManager)</unmanaged>
|
|
<unmanaged-short>MFCreateStandardQualityManager</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateAudioRenderer(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates the Streaming Audio Renderer. </p>
|
|
</summary>
|
|
<param name="audioAttributesRef">No documentation.</param>
|
|
<param name="sinkOut">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To configure the audio renderer, set any of the following attributes on the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface specified in the <em>pAudioAttributes</em> parameter.</p><table> <tr><th>Attribute</th><th>Description</th></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.EndpointId"/></strong> </td><td>The audio endpoint device identifier.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.EndpointRole"/></strong> </td><td>The audio endpoint role.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.Flags"/></strong> </td><td>Miscellaneous configuration flags.</td></tr> <tr><td> <strong><see cref="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.SessionId"/></strong> </td><td>The audio policy class.</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.AudioRendererAttributeKeys.StreamCategory"/> </td><td>The audio stream category.</td></tr> <tr><td> <see cref="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.LowLatency"/> </td><td>Enables low-latency audio streaming.</td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateAudioRenderer']/*"/>
|
|
<msdn-id>ms701557</msdn-id>
|
|
<unmanaged>HRESULT MFCreateAudioRenderer([In] IMFAttributes* pAudioAttributes,[Out] IMFMediaSink** ppSink)</unmanaged>
|
|
<unmanaged-short>MFCreateAudioRenderer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateMP3MediaSink(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates the MP3 media sink.</p>
|
|
</summary>
|
|
<param name="targetByteStreamRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of a byte stream. The media sink writes the MP3 file to this byte stream. The byte stream must be writable.</p> </dd></param>
|
|
<param name="mediaSinkOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface of the MP3 media sink.. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> The MP3 media sink takes compressed MP3
|
|
audio samples as input, and writes an MP3 file with ID3 headers as output. The MP3 media sink does not perform MP3 audio encoding. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateMP3MediaSink']/*"/>
|
|
<msdn-id>dd388098</msdn-id>
|
|
<unmanaged>HRESULT MFCreateMP3MediaSink([In] IMFByteStream* pTargetByteStream,[Out] IMFMediaSink** ppMediaSink)</unmanaged>
|
|
<unmanaged-short>MFCreateMP3MediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.DeserializeAttributesFromStream(SharpDX.MediaFoundation.MediaAttributes,System.Int32,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Loads attributes from a stream into an attribute store.</p>
|
|
</summary>
|
|
<param name="attrRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of the attribute store.</p> </dd></param>
|
|
<param name="dwOptions"><dd> <p>Bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.AttributeSerializeOptions"/></strong> enumeration.</p> </dd></param>
|
|
<param name="stmRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.Win32.IStream"/></strong> interface of the stream from which to read the attributes.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Use this function to deserialize an attribute store that was serialized with the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.SerializeAttributesToStream(SharpDX.MediaFoundation.MediaAttributes,System.Int32,System.IntPtr)"/></strong> function.</p><p>If <em>dwOptions</em> contains the <see cref="F:SharpDX.MediaFoundation.AttributeSerializeOptions.UnknownByref"/> flag, the function deserializes <strong><see cref="T:SharpDX.ComObject"/></strong> references from the stream, as follows:</p><ul> <li> <p>If the <strong><see cref="T:SharpDX.Win32.IStream"/></strong> reference exposes the <strong><see cref="T:SharpDX.MediaFoundation.ObjectReferenceStream"/></strong> interface (through <strong>QueryInterface</strong>), the function calls <strong><see cref="M:SharpDX.MediaFoundation.ObjectReferenceStream.LoadReference(System.Guid,System.IntPtr)"/></strong> to deserialize each reference.</p> </li> <li> <p>Otherwise, the function calls <strong>CoUnmarshalInterface</strong> to deserialize a proxy for the object.</p> </li> </ul><p>This function deletes any attributes that were previously stored in <em>pAttr</em>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFDeserializeAttributesFromStream']/*"/>
|
|
<msdn-id>ms703162</msdn-id>
|
|
<unmanaged>HRESULT MFDeserializeAttributesFromStream([In] IMFAttributes* pAttr,[In] unsigned int dwOptions,[In] IStream* pStm)</unmanaged>
|
|
<unmanaged-short>MFDeserializeAttributesFromStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.SerializeAttributesToStream(SharpDX.MediaFoundation.MediaAttributes,System.Int32,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Loads attributes from a stream into an attribute store.</p>
|
|
</summary>
|
|
<param name="attrRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of the attribute store.</p> </dd></param>
|
|
<param name="dwOptions"><dd> <p>Bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.AttributeSerializeOptions"/></strong> enumeration.</p> </dd></param>
|
|
<param name="stmRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.Win32.IStream"/></strong> interface of the stream from which to read the attributes.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Use this function to deserialize an attribute store that was serialized with the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.SerializeAttributesToStream(SharpDX.MediaFoundation.MediaAttributes,System.Int32,System.IntPtr)"/></strong> function.</p><p>If <em>dwOptions</em> contains the <see cref="F:SharpDX.MediaFoundation.AttributeSerializeOptions.UnknownByref"/> flag, the function deserializes <strong><see cref="T:SharpDX.ComObject"/></strong> references from the stream, as follows:</p><ul> <li> <p>If the <strong><see cref="T:SharpDX.Win32.IStream"/></strong> reference exposes the <strong><see cref="T:SharpDX.MediaFoundation.ObjectReferenceStream"/></strong> interface (through <strong>QueryInterface</strong>), the function calls <strong><see cref="M:SharpDX.MediaFoundation.ObjectReferenceStream.LoadReference(System.Guid,System.IntPtr)"/></strong> to deserialize each reference.</p> </li> <li> <p>Otherwise, the function calls <strong>CoUnmarshalInterface</strong> to deserialize a proxy for the object.</p> </li> </ul><p>This function deletes any attributes that were previously stored in <em>pAttr</em>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFSerializeAttributesToStream']/*"/>
|
|
<msdn-id>ms703162</msdn-id>
|
|
<unmanaged>HRESULT MFSerializeAttributesToStream([In] IMFAttributes* pAttr,[In] unsigned int dwOptions,[In] IStream* pStm)</unmanaged>
|
|
<unmanaged-short>MFSerializeAttributesToStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Creates a new instance of the MFPlay player object.</p>
|
|
</summary>
|
|
<param name="wszURLRef">No documentation.</param>
|
|
<param name="fStartPlayback">No documentation.</param>
|
|
<param name="creationOptions">No documentation.</param>
|
|
<param name="callbackRef">No documentation.</param>
|
|
<param name="hWnd">No documentation.</param>
|
|
<param name="mediaPlayerOut">No documentation.</param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Before calling this function, call <strong>CoIntialize(Ex)</strong> from the same thread to initialize the COM library.</p><p>Internally, <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)"/></strong> calls <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> to initialize the Microsoft Media Foundation platform. When the player object is destroyed, it calls <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> to shut down the platform. It is not necessary for an application to call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> when using MFPlay.</p><p><strong>Note</strong>??If you use other Media Foundation APIs outside the life time of the player object, then your application should call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPCreateMediaPlayer']/*"/>
|
|
<msdn-id>dd375520</msdn-id>
|
|
<unmanaged>HRESULT MFPCreateMediaPlayer([In, Optional] const wchar_t* pwszURL,[In] BOOL fStartPlayback,[In, Optional] unsigned int creationOptions,[In, Optional] IMFPMediaPlayerCallback* pCallback,[In, Optional] HWND hWnd,[Out, Optional] IMFPMediaPlayer** ppMediaPlayer)</unmanaged>
|
|
<unmanaged-short>MFPCreateMediaPlayer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSourceReaderFromByteStream(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SourceReader@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates the source reader from a byte stream.</p>
|
|
</summary>
|
|
<param name="byteStreamRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of a byte stream. This byte stream will provide the source data for the source reader.</p> </dd></param>
|
|
<param name="attributesRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. You can use this parameter to configure the source reader. For more information, see Source Reader Attributes. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="sourceReaderOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.SourceReader"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call <strong>CoInitialize(Ex)</strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> before calling this function.</p><p> Internally, the source reader calls the <strong><see cref="M:SharpDX.MediaFoundation.SourceResolver.CreateObjectFromByteStream(SharpDX.MediaFoundation.ByteStream,System.String,System.Int32,SharpDX.ComObject,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong> method to create a media source from the byte stream. Therefore, a byte-stream handler must be registered for the byte stream. For more information about byte-stream handlers, see Scheme Handlers and Byte-Stream Handlers. </p><p>This function is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSourceReaderFromByteStream']/*"/>
|
|
<msdn-id>dd388106</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSourceReaderFromByteStream([In] IMFByteStream* pByteStream,[In, Optional] IMFAttributes* pAttributes,[Out] IMFSourceReader** ppSourceReader)</unmanaged>
|
|
<unmanaged-short>MFCreateSourceReaderFromByteStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSourceReaderFromURL(System.String,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SourceReader@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates the source reader from a URL.</p>
|
|
</summary>
|
|
<param name="wszURLRef"><dd> <p>The URL of a media file to open.</p> </dd></param>
|
|
<param name="attributesRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. You can use this parameter to configure the source reader. For more information, see Source Reader Attributes. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="sourceReaderOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.SourceReader"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call <strong>CoInitialize(Ex)</strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> before calling this function.</p><p> Internally, the source reader calls the <strong><see cref="M:SharpDX.MediaFoundation.SourceResolver.CreateObjectFromURL(System.String,System.Int32,SharpDX.ComObject,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong> method to create a media source from the URL. </p><p>This function is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSourceReaderFromURL']/*"/>
|
|
<msdn-id>dd388110</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSourceReaderFromURL([In] const wchar_t* pwszURL,[In, Optional] IMFAttributes* pAttributes,[Out] IMFSourceReader** ppSourceReader)</unmanaged>
|
|
<unmanaged-short>MFCreateSourceReaderFromURL</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSourceReaderFromMediaSource(SharpDX.MediaFoundation.MediaSource,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SourceReader@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates the source reader from a media source.</p>
|
|
</summary>
|
|
<param name="mediaSourceRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSource"/></strong> interface of a media source.</p> </dd></param>
|
|
<param name="attributesRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. You can use this parameter to configure the source reader. For more information, see Source Reader Attributes. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="sourceReaderOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.SourceReader"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_DRM_UNSUPPORTED</strong></strong></dt> </dl> </td><td> <p>The source contains protected content.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call <strong>CoInitialize(Ex)</strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> before calling this function.</p><p>By default, when the application releases the source reader, the source reader shuts down the media source by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Shutdown"/></strong> on the media source. At that point, the application can no longer use the media source.</p><p>To change this default behavior, set the <see cref="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.DisconnectMediasourceOnShutdown"/> attribute in the <em>pAttributes</em> parameter. If this attribute is <strong>TRUE</strong>, the application is responsible for shutting down the media source.</p><p>When using the Source Reader, do not call any of the following methods on the media source:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Pause"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Start(SharpDX.MediaFoundation.PresentationDescriptor,System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Stop"/></strong> </li> <li>All <strong><see cref="T:SharpDX.MediaFoundation.MediaEventGenerator"/></strong> methods</li> </ul><p>This function is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSourceReaderFromMediaSource']/*"/>
|
|
<msdn-id>dd388108</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSourceReaderFromMediaSource([In] IMFMediaSource* pMediaSource,[In, Optional] IMFAttributes* pAttributes,[Out] IMFSourceReader** ppSourceReader)</unmanaged>
|
|
<unmanaged-short>MFCreateSourceReaderFromMediaSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSinkWriterFromURL(System.String,SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SinkWriter@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates the sink writer from a URL or byte stream.</p>
|
|
</summary>
|
|
<param name="wszOutputURLRef"><dd> <p>A null-terminated string that contains the URL of the output file. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="byteStreamRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of a byte stream. This parameter can be <strong><c>null</c></strong>.</p> <p>If this parameter is a valid reference, the sink writer writes to the provided byte stream. (The byte stream must be writable.) Otherwise, if <em>pByteStream</em> is <strong><c>null</c></strong>, the sink writer creates a new file named <em>pwszOutputURL</em>.</p> </dd></param>
|
|
<param name="attributesRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. You can use this parameter to configure the sink writer. For more information, see Sink Writer Attributes. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="sinkWriterOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.SinkWriter"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>This function can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_FOUND</strong></dt> </dl> </td><td> <p>The specified URL was not found.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call <strong>CoInitialize(Ex)</strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> before calling this function.</p><p>The first three parameters to this function can be <strong><c>null</c></strong>; however, only certain combinations are valid:</p><p> </p><table> <tr><th>Description</th><th><em>pwszOutputURL</em></th><th><em>pByteStream</em></th><th><em>pAttributes</em></th></tr> <tr><td>Specify a byte stream, with no URL.</td><td><strong><c>null</c></strong></td><td>non-<strong><c>null</c></strong></td><td>Required (must not be <strong><c>null</c></strong>).</td></tr> <tr><td>Specify a URL, with no byte stream.</td><td>not <strong><c>null</c></strong></td><td><strong><c>null</c></strong></td><td>Optional (may be <strong><c>null</c></strong>).</td></tr> <tr><td>Specify both a URL and a byte stream.</td><td>non-<strong><c>null</c></strong></td><td>non-<strong><c>null</c></strong></td><td>Optional (may be <strong><c>null</c></strong>).</td></tr> </table><p>?</p><p>The <em>pAttributes</em> parameter is required in the first case and optional in the others.</p><ul> <li>Case 1: Specify a byte stream without a URL. The <em>pAttributes</em> parameter must point to an attribute store that contains the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute. The sink writer uses the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute to determine the type of file container to write, such as ASF or MP4.</li> <li>Case 2: Specify a URL without a byte stream. The sink writer creates a new file named <em>pwszOutputURL</em>. If <em>pAttributes</em> specifies an attribute store with the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute, the sink writer uses that attribute to determine the type of file container. Otherwise, if the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute is absent or <em>pAttributes</em> is <strong><c>null</c></strong>, the sink writer uses the file name extension to select the container type; for example, ".asf" for an ASF file.</li> <li>Case 3: Specify both a URL and a byte stream. The sink writer writes to the byte stream. The URL provided in <em>pwszOutputURL</em> is informational only; the sink writer does not create a new file. If <em>pAttributes</em> specifies an attribute store with the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute, the sink writer uses that attribute to determine the type of file container. Otherwise, the sink writer uses the file name extension to select the container type. The <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute overrides the URL file name extension in this case.</li> </ul><p>This function is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSinkWriterFromURL']/*"/>
|
|
<msdn-id>dd388105</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSinkWriterFromURL([In, Optional] const wchar_t* pwszOutputURL,[In, Optional] IMFByteStream* pByteStream,[In, Optional] IMFAttributes* pAttributes,[Out] IMFSinkWriter** ppSinkWriter)</unmanaged>
|
|
<unmanaged-short>MFCreateSinkWriterFromURL</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateSinkWriterFromMediaSink(SharpDX.MediaFoundation.MediaSink,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SinkWriter@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates the sink writer from a media sink.</p>
|
|
</summary>
|
|
<param name="mediaSinkRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface of a media sink. </p> </dd></param>
|
|
<param name="attributesRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. You can use this parameter to configure the sink writer. For more information, see Sink Writer Attributes. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="sinkWriterOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.SinkWriter"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call <strong>CoInitialize(Ex)</strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> before calling this function.</p><p>When you are done using the media sink, call the media sink's <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.Shutdown"/></strong> method. (The sink writer does not shut down the media sink.) Release the sink writer before calling <strong>Shutdown</strong> on the media sink.</p><p>This function is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateSinkWriterFromMediaSink']/*"/>
|
|
<msdn-id>dd388103</msdn-id>
|
|
<unmanaged>HRESULT MFCreateSinkWriterFromMediaSink([In] IMFMediaSink* pMediaSink,[In, Optional] IMFAttributes* pAttributes,[Out] IMFSinkWriter** ppSinkWriter)</unmanaged>
|
|
<unmanaged-short>MFCreateSinkWriterFromMediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateTransformActivate(SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="activateOut"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateTransformActivate']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateTransformActivate([Out] IMFActivate** ppActivate)</unmanaged>
|
|
<unmanaged-short>MFCreateTransformActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFProfile(SharpDX.MediaFoundation.ASFProfile@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Manages an Advanced Systems Format (ASF) profile. A profile is a collection of information that describes the configuration of streams that will be included in an ASF file. Information about the relationships between streams is also included in the profile.</p><p>An <strong><see cref="T:SharpDX.MediaFoundation.ASFProfile"/></strong> interface exists for every ASF profile object. To create an ASF profile object, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFProfile(SharpDX.MediaFoundation.ASFProfile@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFProfileFromPresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor,SharpDX.MediaFoundation.ASFProfile@)"/></strong>.</p>
|
|
</summary>
|
|
<param name="iProfileOut">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='MFCreateASFProfile']/*"/>
|
|
<msdn-id>ms705658</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFProfile([In] IMFASFProfile** ppIProfile)</unmanaged>
|
|
<unmanaged-short>MFCreateASFProfile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFStreamingMediaSinkActivate(SharpDX.MediaFoundation.Activate,SharpDX.MediaFoundation.ASFContentInfo,SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates an activation object for the ASF streaming sink.</p><p>The ASF streaming sink enables an application to write streaming Advanced Systems Format (ASF) packets to an HTTP byte stream. The activation object can be used to create the ASF streaming sink in another process.</p>
|
|
</summary>
|
|
<param name="byteStreamActivateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface of an activation object. The caller implements this interface. The <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> method of the activation object must create a byte-stream object. The byte stream exposes the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface. The ASF streaming sink will write data to this byte stream.</p> </dd></param>
|
|
<param name="contentInfoRef"><dd> <p>A reference to an ASF ContentInfo Object that contains the properties that describe the ASF content. These settings can contain stream settings, encoding properties, and metadata. For more information about these properties, see Setting Properties in the ContentInfo Object.</p> </dd></param>
|
|
<param name="iActivateOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface of the activation object that is used to create the ASF streaming-media sink. To create the media sink, the application must call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> by using the received reference. The <strong>ActivateObject</strong> method also calls <strong>IMFActivate::Activate</strong> on the byte stream activate object specified by <em>pByteStreamActivate</em>, to create it so that the media sink can write streamed content in the byte stream. The caller must release the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface reference of the media sink activation object received in <em>ppIActivate</em>.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Starting in Windows?7, Media Foundation provides an ASF streaming sink that writes the content in a live streaming scenario. This function should be used in secure transcode scenarios where this media sink needs to be created and configured in the remote
|
|
process. Like the ASF file sink, the new media sink performs ASF related tasks such as writing the ASF header, generating data packets (muxing). The content is written to a caller-implemented byte stream such as an HTTP byte stream.
|
|
The caller must also provide an activation object that media sink can use to create the byte stream remotely. </p><p>In addition, it performs transcryption for streaming protected content. It hosts the Windows Media Digital Rights Management (DRM) for Network Devices Output Trust Authority (OTA) that handles the license request and response. For more information, see <strong><see cref="T:SharpDX.MediaFoundation.DRMNetHelper"/></strong> interface.</p><p>The new media sink does not perform any time adjustments. If the clock seeks, the timestamps are not changed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFStreamingMediaSinkActivate']/*"/>
|
|
<msdn-id>dd388090</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFStreamingMediaSinkActivate([In] IMFActivate* pByteStreamActivate,[In] IMFASFContentInfo* pContentInfo,[In] IMFActivate** ppIActivate)</unmanaged>
|
|
<unmanaged-short>MFCreateASFStreamingMediaSinkActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreatePresentationDescriptorFromASFProfile(SharpDX.MediaFoundation.ASFProfile,SharpDX.MediaFoundation.PresentationDescriptor@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="iProfileRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="iPDOut"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreatePresentationDescriptorFromASFProfile']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreatePresentationDescriptorFromASFProfile([In] IMFASFProfile* pIProfile,[In] IMFPresentationDescriptor** ppIPD)</unmanaged>
|
|
<unmanaged-short>MFCreatePresentationDescriptorFromASFProfile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFSplitter(SharpDX.MediaFoundation.ASFSplitter@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="iSplitterOut"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFSplitter']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFSplitter([In] IMFASFSplitter** ppISplitter)</unmanaged>
|
|
<unmanaged-short>MFCreateASFSplitter</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFMediaSinkActivate(System.String,SharpDX.MediaFoundation.ASFContentInfo,SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="wszFileNameRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="contentInfoRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="iActivateOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFMediaSinkActivate']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFMediaSinkActivate([In] const wchar_t* pwszFileName,[In] IMFASFContentInfo* pContentInfo,[In] IMFActivate** ppIActivate)</unmanaged>
|
|
<unmanaged-short>MFCreateASFMediaSinkActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFStreamingMediaSink(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates an activation object for the ASF streaming sink.</p><p>The ASF streaming sink enables an application to write streaming Advanced Systems Format (ASF) packets to an HTTP byte stream. </p>
|
|
</summary>
|
|
<param name="iByteStreamRef"><dd> <p> A reference to a byte stream object in which the ASF media sink writes the streamed content.</p> </dd></param>
|
|
<param name="iMediaSinkOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface of the ASF streaming-media sink object. To create the media sink, the application must call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> on the received reference. The caller must release the interface reference.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To create the ASF streaming sink in another process, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFStreamingMediaSinkActivate(SharpDX.MediaFoundation.Activate,SharpDX.MediaFoundation.ASFContentInfo,SharpDX.MediaFoundation.Activate@)"/></strong>. </p><p>An application can get a reference to the ASF ContentInfo Object by calling <strong>IUnknown::QueryInterface</strong> on the media sink object received in the <em>ppIMediaSink</em> parameter. The ContentInfo object is used to set the encoder configuration settings, provide stream properties supplied by an ASF profile, and add metadata information. These configuration settings populate the various ASF header objects of the encoded ASF file. For more information, see
|
|
Setting Properties in the ContentInfo Object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFStreamingMediaSink']/*"/>
|
|
<msdn-id>dd388087</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFStreamingMediaSink([In] IMFByteStream* pIByteStream,[In] IMFMediaSink** ppIMediaSink)</unmanaged>
|
|
<unmanaged-short>MFCreateASFStreamingMediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFProfileFromPresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor,SharpDX.MediaFoundation.ASFProfile@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates an activation object for the ASF streaming sink.</p><p>The ASF streaming sink enables an application to write streaming Advanced Systems Format (ASF) packets to an HTTP byte stream. </p>
|
|
</summary>
|
|
<param name="iPDRef"><dd> <p> A reference to a byte stream object in which the ASF media sink writes the streamed content.</p> </dd></param>
|
|
<param name="iProfileOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface of the ASF streaming-media sink object. To create the media sink, the application must call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> on the received reference. The caller must release the interface reference.</p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To create the ASF streaming sink in another process, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFStreamingMediaSinkActivate(SharpDX.MediaFoundation.Activate,SharpDX.MediaFoundation.ASFContentInfo,SharpDX.MediaFoundation.Activate@)"/></strong>. </p><p>An application can get a reference to the ASF ContentInfo Object by calling <strong>IUnknown::QueryInterface</strong> on the media sink object received in the <em>ppIMediaSink</em> parameter. The ContentInfo object is used to set the encoder configuration settings, provide stream properties supplied by an ASF profile, and add metadata information. These configuration settings populate the various ASF header objects of the encoded ASF file. For more information, see
|
|
Setting Properties in the ContentInfo Object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFProfileFromPresentationDescriptor']/*"/>
|
|
<msdn-id>dd388087</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFProfileFromPresentationDescriptor([In] IMFPresentationDescriptor* pIPD,[In] IMFASFProfile** ppIProfile)</unmanaged>
|
|
<unmanaged-short>MFCreateASFProfileFromPresentationDescriptor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateWMVEncoderActivate(SharpDX.MediaFoundation.MediaType,SharpDX.ComObject,SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="mediaTypeRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="encodingConfigurationPropertiesRef"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="activateOut">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateWMVEncoderActivate']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateWMVEncoderActivate([In] IMFMediaType* pMediaType,[In] IPropertyStore* pEncodingConfigurationProperties,[In] IMFActivate** ppActivate)</unmanaged>
|
|
<unmanaged-short>MFCreateWMVEncoderActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFMultiplexer(SharpDX.MediaFoundation.ASFMultiplexer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="iMultiplexerOut"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFMultiplexer']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFMultiplexer([In] IMFASFMultiplexer** ppIMultiplexer)</unmanaged>
|
|
<unmanaged-short>MFCreateASFMultiplexer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFIndexerByteStream(SharpDX.MediaFoundation.ByteStream,System.Int64,SharpDX.MediaFoundation.ByteStream@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="iContentByteStreamRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="cbIndexStartOffset"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="iIndexByteStreamRef">No documentation.</param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFIndexerByteStream']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFIndexerByteStream([In] IMFByteStream* pIContentByteStream,[In] unsigned longlong cbIndexStartOffset,[In] IMFByteStream** pIIndexByteStream)</unmanaged>
|
|
<unmanaged-short>MFCreateASFIndexerByteStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFStreamSelector(SharpDX.MediaFoundation.ASFProfile,SharpDX.MediaFoundation.ASFStreamSelector@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="iASFProfileRef"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<param name="selectorOut"><dd> <p>This parameter is optional when using C++ but required in C. The value must be one of the following flags: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>MFSTARTUP_NOSOCKET</dt> </dl> </td><td> <p> Do not initialize the sockets library. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_LITE</dt> </dl> </td><td> <p> Equivalent to MFSTARTUP_NOSOCKET. </p> </td></tr> <tr><td> <dl> <dt>MFSTARTUP_FULL</dt> </dl> </td><td> <p> Initialize the entire Media Foundation platform. This is the default value when <em>dwFlags</em> is not specified. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFStreamSelector']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFStreamSelector([In] IMFASFProfile* pIASFProfile,[In] IMFASFStreamSelector** ppSelector)</unmanaged>
|
|
<unmanaged-short>MFCreateASFStreamSelector</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateWMAEncoderActivate(SharpDX.MediaFoundation.MediaType,SharpDX.ComObject,SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates an activation object that can be used to create a Windows Media Audio (WMA) encoder. </p>
|
|
</summary>
|
|
<param name="mediaTypeRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. This parameter specifies the encoded output format.</p> </dd></param>
|
|
<param name="encodingConfigurationPropertiesRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a property store that contains encoding parameters. Encoding parameters for the WMV encoder are defined in the header file wmcodecdsp.h. If you have an ASF ContentInfo object that contains an ASF profile object with all the streams for the output file, you can get the property store by calling <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.GetEncodingConfigurationPropertyStore(System.Int16,SharpDX.ComObject@)"/></strong>. </p> </dd></param>
|
|
<param name="activateOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface. Use this interface to create the encoder. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateWMAEncoderActivate']/*"/>
|
|
<msdn-id>ms702208</msdn-id>
|
|
<unmanaged>HRESULT MFCreateWMAEncoderActivate([In] IMFMediaType* pMediaType,[In] IPropertyStore* pEncodingConfigurationProperties,[In] IMFActivate** ppActivate)</unmanaged>
|
|
<unmanaged-short>MFCreateWMAEncoderActivate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFIndexer(SharpDX.MediaFoundation.ASFIndexer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="iIndexerOut"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFIndexer']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFIndexer([In] IMFASFIndexer** ppIIndexer)</unmanaged>
|
|
<unmanaged-short>MFCreateASFIndexer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFContentInfo(SharpDX.MediaFoundation.ASFContentInfo@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="iContentInfoOut"><dd> <p>Version number. Use the value <strong><see cref="F:SharpDX.MediaFoundation.MediaFactory.Version"/></strong>, defined in mfapi.h.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BAD_STARTUP_VERSION</strong></dt> </dl> </td><td> <p> The <em>Version</em> parameter requires a newer version of Media Foundation than the version that is running.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DISABLED_IN_SAFEMODE</strong></dt> </dl> </td><td> <p> The Media Foundation platform is disabled because the system was started in "Safe Mode" (fail-safe boot). </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFContentInfo']/*"/>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFContentInfo([In] IMFASFContentInfo** ppIContentInfo)</unmanaged>
|
|
<unmanaged-short>MFCreateASFContentInfo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaFactory.CreateASFMediaSink(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates the ASF media sink.</p>
|
|
</summary>
|
|
<param name="iByteStreamRef"><dd> <p>Pointer to a byte stream that will be used to write the ASF stream.</p> </dd></param>
|
|
<param name="iMediaSinkOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The function succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCreateASFMediaSink']/*"/>
|
|
<msdn-id>ms703955</msdn-id>
|
|
<unmanaged>HRESULT MFCreateASFMediaSink([In] IMFByteStream* pIByteStream,[In] IMFMediaSink** ppIMediaSink)</unmanaged>
|
|
<unmanaged-short>MFCreateASFMediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaSessionAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.MediaSessionAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.ApproxEventOccurrenceTime">
|
|
<summary>Constant ApproxEventOccurrenceTime.</summary>
|
|
<unmanaged>MF_SESSION_APPROX_EVENT_OCCURRENCE_TIME</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.ContentProtectionManager">
|
|
<summary>Constant ContentProtectionManager.</summary>
|
|
<unmanaged>MF_SESSION_CONTENT_PROTECTION_MANAGER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.GlobalTime">
|
|
<summary>Constant GlobalTime.</summary>
|
|
<unmanaged>MF_SESSION_GLOBAL_TIME</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.QualityManager">
|
|
<summary>Constant QualityManager.</summary>
|
|
<unmanaged>MF_SESSION_QUALITY_MANAGER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.RemoteSourceMode">
|
|
<summary>Constant RemoteSourceMode.</summary>
|
|
<unmanaged>MF_SESSION_REMOTE_SOURCE_MODE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.ServerContext">
|
|
<summary>Constant ServerContext.</summary>
|
|
<unmanaged>MF_SESSION_SERVER_CONTEXT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.Topoloader">
|
|
<summary>Constant Topoloader.</summary>
|
|
<unmanaged>MF_SESSION_TOPOLOADER</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaTypeAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.MediaTypeAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AacAudioProfileLevelIndication">
|
|
<summary>Constant AacAudioProfileLevelIndication.</summary>
|
|
<unmanaged>MF_MT_AAC_AUDIO_PROFILE_LEVEL_INDICATION</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AacPayloadType">
|
|
<summary>Constant AacPayloadType.</summary>
|
|
<unmanaged>MF_MT_AAC_PAYLOAD_TYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AllSamplesIndependent">
|
|
<summary>Constant AllSamplesIndependent.</summary>
|
|
<unmanaged>MF_MT_ALL_SAMPLES_INDEPENDENT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AmFormatType">
|
|
<summary>Constant AmFormatType.</summary>
|
|
<unmanaged>MF_MT_AM_FORMAT_TYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.ArbitraryFormat">
|
|
<summary>Constant ArbitraryFormat.</summary>
|
|
<unmanaged>MF_MT_ARBITRARY_FORMAT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.ArbitraryHeader">
|
|
<summary>Constant ArbitraryHeader.</summary>
|
|
<unmanaged>MF_MT_ARBITRARY_HEADER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioAvgBytesPerSecond">
|
|
<summary>Constant AudioAvgBytesPerSecond.</summary>
|
|
<unmanaged>MF_MT_AUDIO_AVG_BYTES_PER_SECOND</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioBitsPerSample">
|
|
<summary>Constant AudioBitsPerSample.</summary>
|
|
<unmanaged>MF_MT_AUDIO_BITS_PER_SAMPLE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioBlockAlignment">
|
|
<summary>Constant AudioBlockAlignment.</summary>
|
|
<unmanaged>MF_MT_AUDIO_BLOCK_ALIGNMENT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioChannelMask">
|
|
<summary>Constant AudioChannelMask.</summary>
|
|
<unmanaged>MF_MT_AUDIO_CHANNEL_MASK</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioFloatSamplesPerSecond">
|
|
<summary>Constant AudioFloatSamplesPerSecond.</summary>
|
|
<unmanaged>MF_MT_AUDIO_FLOAT_SAMPLES_PER_SECOND</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioFolddownMatrix">
|
|
<summary>Constant AudioFolddownMatrix.</summary>
|
|
<unmanaged>MF_MT_AUDIO_FOLDDOWN_MATRIX</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioNumChannels">
|
|
<summary>Constant AudioNumChannels.</summary>
|
|
<unmanaged>MF_MT_AUDIO_NUM_CHANNELS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioPreferWaveformatex">
|
|
<summary>Constant AudioPreferWaveformatex.</summary>
|
|
<unmanaged>MF_MT_AUDIO_PREFER_WAVEFORMATEX</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioSamplesPerBlock">
|
|
<summary>Constant AudioSamplesPerBlock.</summary>
|
|
<unmanaged>MF_MT_AUDIO_SAMPLES_PER_BLOCK</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioSamplesPerSecond">
|
|
<summary>Constant AudioSamplesPerSecond.</summary>
|
|
<unmanaged>MF_MT_AUDIO_SAMPLES_PER_SECOND</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioValidBitsPerSample">
|
|
<summary>Constant AudioValidBitsPerSample.</summary>
|
|
<unmanaged>MF_MT_AUDIO_VALID_BITS_PER_SAMPLE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioWmadrcAvgref">
|
|
<summary>Constant AudioWmadrcAvgref.</summary>
|
|
<unmanaged>MF_MT_AUDIO_WMADRC_AVGREF</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioWmadrcAvgtarget">
|
|
<summary>Constant AudioWmadrcAvgtarget.</summary>
|
|
<unmanaged>MF_MT_AUDIO_WMADRC_AVGTARGET</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioWmadrcPeakref">
|
|
<summary>Constant AudioWmadrcPeakref.</summary>
|
|
<unmanaged>MF_MT_AUDIO_WMADRC_PEAKREF</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioWmadrcPeaktarget">
|
|
<summary>Constant AudioWmadrcPeaktarget.</summary>
|
|
<unmanaged>MF_MT_AUDIO_WMADRC_PEAKTARGET</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AvgBitErrorRate">
|
|
<summary>Constant AvgBitErrorRate.</summary>
|
|
<unmanaged>MF_MT_AVG_BIT_ERROR_RATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AvgBitrate">
|
|
<summary>Constant AvgBitrate.</summary>
|
|
<unmanaged>MF_MT_AVG_BITRATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Compressed">
|
|
<summary>Constant Compressed.</summary>
|
|
<unmanaged>MF_MT_COMPRESSED</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.CustomVideoPrimaries">
|
|
<summary>Constant CustomVideoPrimaries.</summary>
|
|
<unmanaged>MF_MT_CUSTOM_VIDEO_PRIMARIES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.DefaultStride">
|
|
<summary>Constant DefaultStride.</summary>
|
|
<unmanaged>MF_MT_DEFAULT_STRIDE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.DrmFlags">
|
|
<summary>Constant DrmFlags.</summary>
|
|
<unmanaged>MF_MT_DRM_FLAGS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.DvAauxCtrlPack0">
|
|
<summary>Constant DvAauxCtrlPack0.</summary>
|
|
<unmanaged>MF_MT_DV_AAUX_CTRL_PACK_0</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.DvAauxCtrlPack1">
|
|
<summary>Constant DvAauxCtrlPack1.</summary>
|
|
<unmanaged>MF_MT_DV_AAUX_CTRL_PACK_1</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.DvAauxSrcPack0">
|
|
<summary>Constant DvAauxSrcPack0.</summary>
|
|
<unmanaged>MF_MT_DV_AAUX_SRC_PACK_0</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.DvAauxSrcPack1">
|
|
<summary>Constant DvAauxSrcPack1.</summary>
|
|
<unmanaged>MF_MT_DV_AAUX_SRC_PACK_1</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.DvVauxCtrlPack">
|
|
<summary>Constant DvVauxCtrlPack.</summary>
|
|
<unmanaged>MF_MT_DV_VAUX_CTRL_PACK</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.DvVauxSrcPack">
|
|
<summary>Constant DvVauxSrcPack.</summary>
|
|
<unmanaged>MF_MT_DV_VAUX_SRC_PACK</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.FixedSizeSamples">
|
|
<summary>Constant FixedSizeSamples.</summary>
|
|
<unmanaged>MF_MT_FIXED_SIZE_SAMPLES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.FrameRate">
|
|
<summary>Constant FrameRate.</summary>
|
|
<unmanaged>MF_MT_FRAME_RATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.FrameRateRangeMax">
|
|
<summary>Constant FrameRateRangeMax.</summary>
|
|
<unmanaged>MF_MT_FRAME_RATE_RANGE_MAX</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.FrameRateRangeMin">
|
|
<summary>Constant FrameRateRangeMin.</summary>
|
|
<unmanaged>MF_MT_FRAME_RATE_RANGE_MIN</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.FrameSize">
|
|
<summary>Constant FrameSize.</summary>
|
|
<unmanaged>MF_MT_FRAME_SIZE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.GeometricAperture">
|
|
<summary>Constant GeometricAperture.</summary>
|
|
<unmanaged>MF_MT_GEOMETRIC_APERTURE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264Capabilities">
|
|
<summary>Constant H264Capabilities.</summary>
|
|
<unmanaged>MF_MT_H264_CAPABILITIES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264MaxCodecConfigDelay">
|
|
<summary>Constant H264MaxCodecConfigDelay.</summary>
|
|
<unmanaged>MF_MT_H264_MAX_CODEC_CONFIG_DELAY</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264MaxMbPerSec">
|
|
<summary>Constant H264MaxMbPerSec.</summary>
|
|
<unmanaged>MF_MT_H264_MAX_MB_PER_SEC</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264RateControlModes">
|
|
<summary>Constant H264RateControlModes.</summary>
|
|
<unmanaged>MF_MT_H264_RATE_CONTROL_MODES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264SimulcastSupport">
|
|
<summary>Constant H264SimulcastSupport.</summary>
|
|
<unmanaged>MF_MT_H264_SIMULCAST_SUPPORT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264SupportedRateControlModes">
|
|
<summary>Constant H264SupportedRateControlModes.</summary>
|
|
<unmanaged>MF_MT_H264_SUPPORTED_RATE_CONTROL_MODES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264SupportedSliceModes">
|
|
<summary>Constant H264SupportedSliceModes.</summary>
|
|
<unmanaged>MF_MT_H264_SUPPORTED_SLICE_MODES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264SupportedSyncFrameTypes">
|
|
<summary>Constant H264SupportedSyncFrameTypes.</summary>
|
|
<unmanaged>MF_MT_H264_SUPPORTED_SYNC_FRAME_TYPES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264SupportedUsages">
|
|
<summary>Constant H264SupportedUsages.</summary>
|
|
<unmanaged>MF_MT_H264_SUPPORTED_USAGES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264SvcCapabilities">
|
|
<summary>Constant H264SvcCapabilities.</summary>
|
|
<unmanaged>MF_MT_H264_SVC_CAPABILITIES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.H264Usage">
|
|
<summary>Constant H264Usage.</summary>
|
|
<unmanaged>MF_MT_H264_USAGE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.ImageLossTolerant">
|
|
<summary>Constant ImageLossTolerant.</summary>
|
|
<unmanaged>MF_MT_IMAGE_LOSS_TOLERANT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.InterlaceMode">
|
|
<summary>Constant InterlaceMode.</summary>
|
|
<unmanaged>MF_MT_INTERLACE_MODE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.MajorType">
|
|
<summary>Constant MajorType.</summary>
|
|
<unmanaged>MF_MT_MAJOR_TYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.MaxKeyframeSpacing">
|
|
<summary>Constant MaxKeyframeSpacing.</summary>
|
|
<unmanaged>MF_MT_MAX_KEYFRAME_SPACING</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.MinimumDisplayAperture">
|
|
<summary>Constant MinimumDisplayAperture.</summary>
|
|
<unmanaged>MF_MT_MINIMUM_DISPLAY_APERTURE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.MpegSequenceHeader">
|
|
<summary>Constant MpegSequenceHeader.</summary>
|
|
<unmanaged>MF_MT_MPEG_SEQUENCE_HEADER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.MpegStartTimeCode">
|
|
<summary>Constant MpegStartTimeCode.</summary>
|
|
<unmanaged>MF_MT_MPEG_START_TIME_CODE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Mpeg2ContentPACKET">
|
|
<summary>Constant Mpeg2ContentPACKET.</summary>
|
|
<unmanaged>MF_MT_MPEG2_CONTENT_PACKET</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Mpeg2Flags">
|
|
<summary>Constant Mpeg2Flags.</summary>
|
|
<unmanaged>MF_MT_MPEG2_FLAGS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Mpeg2Level">
|
|
<summary>Constant Mpeg2Level.</summary>
|
|
<unmanaged>MF_MT_MPEG2_LEVEL</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Mpeg2Profile">
|
|
<summary>Constant Mpeg2Profile.</summary>
|
|
<unmanaged>MF_MT_MPEG2_PROFILE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Mpeg2STANDARD">
|
|
<summary>Constant Mpeg2STANDARD.</summary>
|
|
<unmanaged>MF_MT_MPEG2_STANDARD</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Mpeg2TIMECODE">
|
|
<summary>Constant Mpeg2TIMECODE.</summary>
|
|
<unmanaged>MF_MT_MPEG2_TIMECODE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Mpeg4CurrentSampleEntry">
|
|
<summary>Constant Mpeg4CurrentSampleEntry.</summary>
|
|
<unmanaged>MF_MT_MPEG4_CURRENT_SAMPLE_ENTRY</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Mpeg4SampleDescription">
|
|
<summary>Constant Mpeg4SampleDescription.</summary>
|
|
<unmanaged>MF_MT_MPEG4_SAMPLE_DESCRIPTION</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Original4cc">
|
|
<summary>Constant Original4cc.</summary>
|
|
<unmanaged>MF_MT_ORIGINAL_4CC</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.OriginalWaveFormatTag">
|
|
<summary>Constant OriginalWaveFormatTag.</summary>
|
|
<unmanaged>MF_MT_ORIGINAL_WAVE_FORMAT_TAG</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.PadControlFlags">
|
|
<summary>Constant PadControlFlags.</summary>
|
|
<unmanaged>MF_MT_PAD_CONTROL_FLAGS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Palette">
|
|
<summary>Constant Palette.</summary>
|
|
<unmanaged>MF_MT_PALETTE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.PanScanAperture">
|
|
<summary>Constant PanScanAperture.</summary>
|
|
<unmanaged>MF_MT_PAN_SCAN_APERTURE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.PanScanEnabled">
|
|
<summary>Constant PanScanEnabled.</summary>
|
|
<unmanaged>MF_MT_PAN_SCAN_ENABLED</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.PixelAspectRatio">
|
|
<summary>Constant PixelAspectRatio.</summary>
|
|
<unmanaged>MF_MT_PIXEL_ASPECT_RATIO</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.SampleSize">
|
|
<summary>Constant SampleSize.</summary>
|
|
<unmanaged>MF_MT_SAMPLE_SIZE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.SourceContentHint">
|
|
<summary>Constant SourceContentHint.</summary>
|
|
<unmanaged>MF_MT_SOURCE_CONTENT_HINT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Subtype">
|
|
<summary>Constant Subtype.</summary>
|
|
<unmanaged>MF_MT_SUBTYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.TimestampCanBeDTS">
|
|
<summary>Constant TimestampCanBeDTS.</summary>
|
|
<unmanaged>MF_MT_TIMESTAMP_CAN_BE_DTS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.TransferFunction">
|
|
<summary>Constant TransferFunction.</summary>
|
|
<unmanaged>MF_MT_TRANSFER_FUNCTION</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.UserData">
|
|
<summary>Constant UserData.</summary>
|
|
<unmanaged>MF_MT_USER_DATA</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Video3d">
|
|
<summary>Constant Video3d.</summary>
|
|
<unmanaged>MF_MT_VIDEO_3D</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Video3dFirstIsLeft">
|
|
<summary>Constant Video3dFirstIsLeft.</summary>
|
|
<unmanaged>MF_MT_VIDEO_3D_FIRST_IS_LEFT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Video3dFormat">
|
|
<summary>Constant Video3dFormat.</summary>
|
|
<unmanaged>MF_MT_VIDEO_3D_FORMAT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Video3dLeftIsBase">
|
|
<summary>Constant Video3dLeftIsBase.</summary>
|
|
<unmanaged>MF_MT_VIDEO_3D_LEFT_IS_BASE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Video3dNumViews">
|
|
<summary>Constant Video3dNumViews.</summary>
|
|
<unmanaged>MF_MT_VIDEO_3D_NUM_VIEWS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.VideoChromaSiting">
|
|
<summary>Constant VideoChromaSiting.</summary>
|
|
<unmanaged>MF_MT_VIDEO_CHROMA_SITING</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.VideoLighting">
|
|
<summary>Constant VideoLighting.</summary>
|
|
<unmanaged>MF_MT_VIDEO_LIGHTING</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.VideoNominalRange">
|
|
<summary>Constant VideoNominalRange.</summary>
|
|
<unmanaged>MF_MT_VIDEO_NOMINAL_RANGE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.VideoPrimaries">
|
|
<summary>Constant VideoPrimaries.</summary>
|
|
<unmanaged>MF_MT_VIDEO_PRIMARIES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.VideoRotation">
|
|
<summary>Constant VideoRotation.</summary>
|
|
<unmanaged>MF_MT_VIDEO_ROTATION</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.WrappedType">
|
|
<summary>Constant WrappedType.</summary>
|
|
<unmanaged>MF_MT_WRAPPED_TYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.YuvMatrix">
|
|
<summary>Constant YuvMatrix.</summary>
|
|
<unmanaged>MF_MT_YUV_MATRIX</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AppContext">
|
|
<summary>Constant AppContext.</summary>
|
|
<unmanaged>MF_PD_APP_CONTEXT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfCodeclist">
|
|
<summary>Constant AsfCodeclist.</summary>
|
|
<unmanaged>MF_PD_ASF_CODECLIST</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfContentencryptionKeyid">
|
|
<summary>Constant AsfContentencryptionKeyid.</summary>
|
|
<unmanaged>MF_PD_ASF_CONTENTENCRYPTION_KEYID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfContentencryptionLicenseUrl">
|
|
<summary>Constant AsfContentencryptionLicenseUrl.</summary>
|
|
<unmanaged>MF_PD_ASF_CONTENTENCRYPTION_LICENSE_URL</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfContentencryptionSecretData">
|
|
<summary>Constant AsfContentencryptionSecretData.</summary>
|
|
<unmanaged>MF_PD_ASF_CONTENTENCRYPTION_SECRET_DATA</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfContentencryptionType">
|
|
<summary>Constant AsfContentencryptionType.</summary>
|
|
<unmanaged>MF_PD_ASF_CONTENTENCRYPTION_TYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfContentencryptionexEncryptionData">
|
|
<summary>Constant AsfContentencryptionexEncryptionData.</summary>
|
|
<unmanaged>MF_PD_ASF_CONTENTENCRYPTIONEX_ENCRYPTION_DATA</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfDataLength">
|
|
<summary>Constant AsfDataLength.</summary>
|
|
<unmanaged>MF_PD_ASF_DATA_LENGTH</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfDataStartOffset">
|
|
<summary>Constant AsfDataStartOffset.</summary>
|
|
<unmanaged>MF_PD_ASF_DATA_START_OFFSET</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfFilepropertiesCreationTime">
|
|
<summary>Constant AsfFilepropertiesCreationTime.</summary>
|
|
<unmanaged>MF_PD_ASF_FILEPROPERTIES_CREATION_TIME</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfFilepropertiesFileId">
|
|
<summary>Constant AsfFilepropertiesFileId.</summary>
|
|
<unmanaged>MF_PD_ASF_FILEPROPERTIES_FILE_ID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfFilepropertiesFlags">
|
|
<summary>Constant AsfFilepropertiesFlags.</summary>
|
|
<unmanaged>MF_PD_ASF_FILEPROPERTIES_FLAGS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfFilepropertiesMaxBitrate">
|
|
<summary>Constant AsfFilepropertiesMaxBitrate.</summary>
|
|
<unmanaged>MF_PD_ASF_FILEPROPERTIES_MAX_BITRATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfFilepropertiesMaxPacketSize">
|
|
<summary>Constant AsfFilepropertiesMaxPacketSize.</summary>
|
|
<unmanaged>MF_PD_ASF_FILEPROPERTIES_MAX_PACKET_SIZE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfFilepropertiesMinPacketSize">
|
|
<summary>Constant AsfFilepropertiesMinPacketSize.</summary>
|
|
<unmanaged>MF_PD_ASF_FILEPROPERTIES_MIN_PACKET_SIZE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfFilepropertiesPackets">
|
|
<summary>Constant AsfFilepropertiesPackets.</summary>
|
|
<unmanaged>MF_PD_ASF_FILEPROPERTIES_PACKETS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfFilepropertiesPlayDuration">
|
|
<summary>Constant AsfFilepropertiesPlayDuration.</summary>
|
|
<unmanaged>MF_PD_ASF_FILEPROPERTIES_PLAY_DURATION</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfFilepropertiesPreroll">
|
|
<summary>Constant AsfFilepropertiesPreroll.</summary>
|
|
<unmanaged>MF_PD_ASF_FILEPROPERTIES_PREROLL</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfFilepropertiesSendDuration">
|
|
<summary>Constant AsfFilepropertiesSendDuration.</summary>
|
|
<unmanaged>MF_PD_ASF_FILEPROPERTIES_SEND_DURATION</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfInfoHasAudio">
|
|
<summary>Constant AsfInfoHasAudio.</summary>
|
|
<unmanaged>MF_PD_ASF_INFO_HAS_AUDIO</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfInfoHasNonAudioVideo">
|
|
<summary>Constant AsfInfoHasNonAudioVideo.</summary>
|
|
<unmanaged>MF_PD_ASF_INFO_HAS_NON_AUDIO_VIDEO</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfInfoHasVideo">
|
|
<summary>Constant AsfInfoHasVideo.</summary>
|
|
<unmanaged>MF_PD_ASF_INFO_HAS_VIDEO</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfLanglist">
|
|
<summary>Constant AsfLanglist.</summary>
|
|
<unmanaged>MF_PD_ASF_LANGLIST</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfLanglistLegacyorder">
|
|
<summary>Constant AsfLanglistLegacyorder.</summary>
|
|
<unmanaged>MF_PD_ASF_LANGLIST_LEGACYORDER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfMarker">
|
|
<summary>Constant AsfMarker.</summary>
|
|
<unmanaged>MF_PD_ASF_MARKER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfMetadataIsVbr">
|
|
<summary>Constant AsfMetadataIsVbr.</summary>
|
|
<unmanaged>MF_PD_ASF_METADATA_IS_VBR</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfMetadataLeakyBucketPairs">
|
|
<summary>Constant AsfMetadataLeakyBucketPairs.</summary>
|
|
<unmanaged>MF_PD_ASF_METADATA_LEAKY_BUCKET_PAIRS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfMetadataV8Bufferaverage">
|
|
<summary>Constant AsfMetadataV8Bufferaverage.</summary>
|
|
<unmanaged>MF_PD_ASF_METADATA_V8_BUFFERAVERAGE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfMetadataV8Vbrpeak">
|
|
<summary>Constant AsfMetadataV8Vbrpeak.</summary>
|
|
<unmanaged>MF_PD_ASF_METADATA_V8_VBRPEAK</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AsfScript">
|
|
<summary>Constant AsfScript.</summary>
|
|
<unmanaged>MF_PD_ASF_SCRIPT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AudioEncodingBitrate">
|
|
<summary>Constant AudioEncodingBitrate.</summary>
|
|
<unmanaged>MF_PD_AUDIO_ENCODING_BITRATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.AudioIsvariablebitrate">
|
|
<summary>Constant AudioIsvariablebitrate.</summary>
|
|
<unmanaged>MF_PD_AUDIO_ISVARIABLEBITRATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.Duration">
|
|
<summary>Constant Duration.</summary>
|
|
<unmanaged>MF_PD_DURATION</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.LastModifiedTime">
|
|
<summary>Constant LastModifiedTime.</summary>
|
|
<unmanaged>MF_PD_LAST_MODIFIED_TIME</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.MimeType">
|
|
<summary>Constant MimeType.</summary>
|
|
<unmanaged>MF_PD_MIME_TYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.PlaybackBoundaryTime">
|
|
<summary>Constant PlaybackBoundaryTime.</summary>
|
|
<unmanaged>MF_PD_PLAYBACK_BOUNDARY_TIME</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.PlaybackElementId">
|
|
<summary>Constant PlaybackElementId.</summary>
|
|
<unmanaged>MF_PD_PLAYBACK_ELEMENT_ID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.PmphostContext">
|
|
<summary>Constant PmphostContext.</summary>
|
|
<unmanaged>MF_PD_PMPHOST_CONTEXT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.PreferredLanguage">
|
|
<summary>Constant PreferredLanguage.</summary>
|
|
<unmanaged>MF_PD_PREFERRED_LANGUAGE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.SamiStylelist">
|
|
<summary>Constant SamiStylelist.</summary>
|
|
<unmanaged>MF_PD_SAMI_STYLELIST</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.TotalFileSize">
|
|
<summary>Constant TotalFileSize.</summary>
|
|
<unmanaged>MF_PD_TOTAL_FILE_SIZE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PresentationDescriptionAttributeKeys.VideoEncodingBitrate">
|
|
<summary>Constant VideoEncodingBitrate.</summary>
|
|
<unmanaged>MF_PD_VIDEO_ENCODING_BITRATE</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SampleAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.SampleAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.Video3D">
|
|
<summary>Constant Video3D.</summary>
|
|
<unmanaged>MFSampleExtension_3DVideo</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.Video3DSampleFormat">
|
|
<summary>Constant Video3DSampleFormat.</summary>
|
|
<unmanaged>MFSampleExtension_3DVideo_SampleFormat</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.BottomFieldFirst">
|
|
<summary>Constant BottomFieldFirst.</summary>
|
|
<unmanaged>MFSampleExtension_BottomFieldFirst</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.CleanPoint">
|
|
<summary>Constant CleanPoint.</summary>
|
|
<unmanaged>MFSampleExtension_CleanPoint</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.DecodeTimestamp">
|
|
<summary>Constant DecodeTimestamp.</summary>
|
|
<unmanaged>MFSampleExtension_DecodeTimestamp</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.DerivedFromTopField">
|
|
<summary>Constant DerivedFromTopField.</summary>
|
|
<unmanaged>MFSampleExtension_DerivedFromTopField</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.DeviceTimestamp">
|
|
<summary>Constant DeviceTimestamp.</summary>
|
|
<unmanaged>MFSampleExtension_DeviceTimestamp</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.Discontinuity">
|
|
<summary>Constant Discontinuity.</summary>
|
|
<unmanaged>MFSampleExtension_Discontinuity</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.FrameCorruption">
|
|
<summary>Constant FrameCorruption.</summary>
|
|
<unmanaged>MFSampleExtension_FrameCorruption</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.Interlaced">
|
|
<summary>Constant Interlaced.</summary>
|
|
<unmanaged>MFSampleExtension_Interlaced</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.PacketCrossOffsets">
|
|
<summary>Constant PacketCrossOffsets.</summary>
|
|
<unmanaged>MFSampleExtension_PacketCrossOffsets</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.RepeatFirstField">
|
|
<summary>Constant RepeatFirstField.</summary>
|
|
<unmanaged>MFSampleExtension_RepeatFirstField</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.SingleField">
|
|
<summary>Constant SingleField.</summary>
|
|
<unmanaged>MFSampleExtension_SingleField</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.Token">
|
|
<summary>Constant Token.</summary>
|
|
<unmanaged>MFSampleExtension_Token</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.VideoEncodePictureType">
|
|
<summary>Constant VideoEncodePictureType.</summary>
|
|
<unmanaged>MFSampleExtension_VideoEncodePictureType</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleAttributeKeys.VideoEncodeQP">
|
|
<summary>Constant VideoEncodeQP.</summary>
|
|
<unmanaged>MFSampleExtension_VideoEncodeQP</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SampleGrabberSinkAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.SampleGrabberSinkAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleGrabberSinkAttributeKeys.IgnoreClock">
|
|
<summary>Constant IgnoreClock.</summary>
|
|
<unmanaged>MF_SAMPLEGRABBERSINK_IGNORE_CLOCK</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SampleGrabberSinkAttributeKeys.SampleTimeOffset">
|
|
<summary>Constant SampleTimeOffset.</summary>
|
|
<unmanaged>MF_SAMPLEGRABBERSINK_SAMPLE_TIME_OFFSET</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SinkWriterAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.SinkWriterAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.LowLatency">
|
|
<summary>Constant LowLatency.</summary>
|
|
<unmanaged>MF_LOW_LATENCY</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.ReadwriteD3DOptional">
|
|
<summary>Constant ReadwriteD3DOptional.</summary>
|
|
<unmanaged>MF_READWRITE_D3D_OPTIONAL</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.ReadwriteDisableConverters">
|
|
<summary>Constant ReadwriteDisableConverters.</summary>
|
|
<unmanaged>MF_READWRITE_DISABLE_CONVERTERS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.ReadwriteEnableHardwareTransforms">
|
|
<summary>Constant ReadwriteEnableHardwareTransforms.</summary>
|
|
<unmanaged>MF_READWRITE_ENABLE_HARDWARE_TRANSFORMS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.ReadwriteMmcssClass">
|
|
<summary>Constant ReadwriteMmcssClass.</summary>
|
|
<unmanaged>MF_READWRITE_MMCSS_CLASS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.ReadwriteMmcssClassAudio">
|
|
<summary>Constant ReadwriteMmcssClassAudio.</summary>
|
|
<unmanaged>MF_READWRITE_MMCSS_CLASS_AUDIO</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.ReadwriteMmcssPriority">
|
|
<summary>Constant ReadwriteMmcssPriority.</summary>
|
|
<unmanaged>MF_READWRITE_MMCSS_PRIORITY</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.ReadwriteMmcssPriorityAudio">
|
|
<summary>Constant ReadwriteMmcssPriorityAudio.</summary>
|
|
<unmanaged>MF_READWRITE_MMCSS_PRIORITY_AUDIO</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.AsyncCallback">
|
|
<summary>Constant AsyncCallback.</summary>
|
|
<unmanaged>MF_SINK_WRITER_ASYNC_CALLBACK</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.D3DManager">
|
|
<summary>Constant D3DManager.</summary>
|
|
<unmanaged>MF_SINK_WRITER_D3D_MANAGER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.DisableThrottling">
|
|
<summary>Constant DisableThrottling.</summary>
|
|
<unmanaged>MF_SINK_WRITER_DISABLE_THROTTLING</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.EncoderConfig">
|
|
<summary>Constant EncoderConfig.</summary>
|
|
<unmanaged>MF_SINK_WRITER_ENCODER_CONFIG</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SourceReaderAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.SourceReaderAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.AsyncCallback">
|
|
<summary>Constant AsyncCallback.</summary>
|
|
<unmanaged>MF_SOURCE_READER_ASYNC_CALLBACK</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.D3DManager">
|
|
<summary>Constant D3DManager.</summary>
|
|
<unmanaged>MF_SOURCE_READER_D3D_MANAGER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.DisableCameraPlugins">
|
|
<summary>Constant DisableCameraPlugins.</summary>
|
|
<unmanaged>MF_SOURCE_READER_DISABLE_CAMERA_PLUGINS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.DisableDxva">
|
|
<summary>Constant DisableDxva.</summary>
|
|
<unmanaged>MF_SOURCE_READER_DISABLE_DXVA</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.DisconnectMediasourceOnShutdown">
|
|
<summary>Constant DisconnectMediasourceOnShutdown.</summary>
|
|
<unmanaged>MF_SOURCE_READER_DISCONNECT_MEDIASOURCE_ON_SHUTDOWN</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.EnableAdvancedVideoProcessing">
|
|
<summary>Constant EnableAdvancedVideoProcessing.</summary>
|
|
<unmanaged>MF_SOURCE_READER_ENABLE_ADVANCED_VIDEO_PROCESSING</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.EnableTranscodeOnlyTransforms">
|
|
<summary>Constant EnableTranscodeOnlyTransforms.</summary>
|
|
<unmanaged>MF_SOURCE_READER_ENABLE_TRANSCODE_ONLY_TRANSFORMS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.EnableVideoProcessing">
|
|
<summary>Constant EnableVideoProcessing.</summary>
|
|
<unmanaged>MF_SOURCE_READER_ENABLE_VIDEO_PROCESSING</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.MediaSourceCharacteristics">
|
|
<summary>Constant MediaSourceCharacteristics.</summary>
|
|
<unmanaged>MF_SOURCE_READER_MEDIASOURCE_CHARACTERISTICS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.MediaSourceConfig">
|
|
<summary>Constant MediaSourceConfig.</summary>
|
|
<unmanaged>MF_SOURCE_READER_MEDIASOURCE_CONFIG</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.StreamDescriptorAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.AsfExtstrmpropAvgBuffersize">
|
|
<summary>Constant AsfExtstrmpropAvgBuffersize.</summary>
|
|
<unmanaged>MF_SD_ASF_EXTSTRMPROP_AVG_BUFFERSIZE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.AsfExtstrmpropAvgDataBitrate">
|
|
<summary>Constant AsfExtstrmpropAvgDataBitrate.</summary>
|
|
<unmanaged>MF_SD_ASF_EXTSTRMPROP_AVG_DATA_BITRATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.AsfExtstrmpropLanguageIdIndex">
|
|
<summary>Constant AsfExtstrmpropLanguageIdIndex.</summary>
|
|
<unmanaged>MF_SD_ASF_EXTSTRMPROP_LANGUAGE_ID_INDEX</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.AsfExtstrmpropMaxBuffersize">
|
|
<summary>Constant AsfExtstrmpropMaxBuffersize.</summary>
|
|
<unmanaged>MF_SD_ASF_EXTSTRMPROP_MAX_BUFFERSIZE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.AsfExtstrmpropMaxDataBitrate">
|
|
<summary>Constant AsfExtstrmpropMaxDataBitrate.</summary>
|
|
<unmanaged>MF_SD_ASF_EXTSTRMPROP_MAX_DATA_BITRATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.AsfMetadataDeviceConformanceTemplate">
|
|
<summary>Constant AsfMetadataDeviceConformanceTemplate.</summary>
|
|
<unmanaged>MF_SD_ASF_METADATA_DEVICE_CONFORMANCE_TEMPLATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.AsfStreambitratesBitrate">
|
|
<summary>Constant AsfStreambitratesBitrate.</summary>
|
|
<unmanaged>MF_SD_ASF_STREAMBITRATES_BITRATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.Language">
|
|
<summary>Constant Language.</summary>
|
|
<unmanaged>MF_SD_LANGUAGE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.MutuallyExclusive">
|
|
<summary>Constant MutuallyExclusive.</summary>
|
|
<unmanaged>MF_SD_MUTUALLY_EXCLUSIVE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.Protected">
|
|
<summary>Constant Protected.</summary>
|
|
<unmanaged>MF_SD_PROTECTED</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.SamiLanguage">
|
|
<summary>Constant SamiLanguage.</summary>
|
|
<unmanaged>MF_SD_SAMI_LANGUAGE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamDescriptorAttributeKeys.StreamName">
|
|
<summary>Constant StreamName.</summary>
|
|
<unmanaged>MF_SD_STREAM_NAME</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TopologyAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.TopologyAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.DXVAMode">
|
|
<summary>Constant DXVAMode.</summary>
|
|
<unmanaged>MF_TOPOLOGY_DXVA_MODE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.DynamicChangeNotAllowed">
|
|
<summary>Constant DynamicChangeNotAllowed.</summary>
|
|
<unmanaged>MF_TOPOLOGY_DYNAMIC_CHANGE_NOT_ALLOWED</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.EnumerateSourceTypes">
|
|
<summary>Constant EnumerateSourceTypes.</summary>
|
|
<unmanaged>MF_TOPOLOGY_ENUMERATE_SOURCE_TYPES</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.HardwareMode">
|
|
<summary>Constant HardwareMode.</summary>
|
|
<unmanaged>MF_TOPOLOGY_HARDWARE_MODE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.NoMarkinMarkout">
|
|
<summary>Constant NoMarkinMarkout.</summary>
|
|
<unmanaged>MF_TOPOLOGY_NO_MARKIN_MARKOUT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.PlaybackFramerate">
|
|
<summary>Constant PlaybackFramerate.</summary>
|
|
<unmanaged>MF_TOPOLOGY_PLAYBACK_FRAMERATE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.PlaybackMaxDimensions">
|
|
<summary>Constant PlaybackMaxDimensions.</summary>
|
|
<unmanaged>MF_TOPOLOGY_PLAYBACK_MAX_DIMS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.ProjectStart">
|
|
<summary>Constant ProjectStart.</summary>
|
|
<unmanaged>MF_TOPOLOGY_PROJECTSTART</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.ProjectStop">
|
|
<summary>Constant ProjectStop.</summary>
|
|
<unmanaged>MF_TOPOLOGY_PROJECTSTOP</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.ResolutionStatus">
|
|
<summary>Constant ResolutionStatus.</summary>
|
|
<unmanaged>MF_TOPOLOGY_RESOLUTION_STATUS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.StartTimeOnPresentationSwitch">
|
|
<summary>Constant StartTimeOnPresentationSwitch.</summary>
|
|
<unmanaged>MF_TOPOLOGY_START_TIME_ON_PRESENTATION_SWITCH</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyAttributeKeys.StaticPlaybackOptimizations">
|
|
<summary>Constant StaticPlaybackOptimizations.</summary>
|
|
<unmanaged>MF_TOPOLOGY_STATIC_PLAYBACK_OPTIMIZATIONS</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TopologyNodeAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.TopologyNodeAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.ConnectMethod">
|
|
<summary>Constant ConnectMethod.</summary>
|
|
<unmanaged>MF_TOPONODE_CONNECT_METHOD</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.D3DAWARE">
|
|
<summary>Constant D3DAWARE.</summary>
|
|
<unmanaged>MF_TOPONODE_D3DAWARE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Decoder">
|
|
<summary>Constant Decoder.</summary>
|
|
<unmanaged>MF_TOPONODE_DECODER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Decryptor">
|
|
<summary>Constant Decryptor.</summary>
|
|
<unmanaged>MF_TOPONODE_DECRYPTOR</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.DisablePreroll">
|
|
<summary>Constant DisablePreroll.</summary>
|
|
<unmanaged>MF_TOPONODE_DISABLE_PREROLL</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Discardable">
|
|
<summary>Constant Discardable.</summary>
|
|
<unmanaged>MF_TOPONODE_DISCARDABLE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Drain">
|
|
<summary>Constant Drain.</summary>
|
|
<unmanaged>MF_TOPONODE_DRAIN</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.ErrorMajortype">
|
|
<summary>Constant ErrorMajortype.</summary>
|
|
<unmanaged>MF_TOPONODE_ERROR_MAJORTYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.ErrorSubtype">
|
|
<summary>Constant ErrorSubtype.</summary>
|
|
<unmanaged>MF_TOPONODE_ERROR_SUBTYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Errorcode">
|
|
<summary>Constant Errorcode.</summary>
|
|
<unmanaged>MF_TOPONODE_ERRORCODE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Flush">
|
|
<summary>Constant Flush.</summary>
|
|
<unmanaged>MF_TOPONODE_FLUSH</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Locked">
|
|
<summary>Constant Locked.</summary>
|
|
<unmanaged>MF_TOPONODE_LOCKED</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.MarkinHere">
|
|
<summary>Constant MarkinHere.</summary>
|
|
<unmanaged>MF_TOPONODE_MARKIN_HERE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.MarkoutHere">
|
|
<summary>Constant MarkoutHere.</summary>
|
|
<unmanaged>MF_TOPONODE_MARKOUT_HERE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Mediastart">
|
|
<summary>Constant Mediastart.</summary>
|
|
<unmanaged>MF_TOPONODE_MEDIASTART</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Mediastop">
|
|
<summary>Constant Mediastop.</summary>
|
|
<unmanaged>MF_TOPONODE_MEDIASTOP</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.NoshutdownOnRemove">
|
|
<summary>Constant NoshutdownOnRemove.</summary>
|
|
<unmanaged>MF_TOPONODE_NOSHUTDOWN_ON_REMOVE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.PresentationDescriptor">
|
|
<summary>Constant PresentationDescriptor.</summary>
|
|
<unmanaged>MF_TOPONODE_PRESENTATION_DESCRIPTOR</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Primaryoutput">
|
|
<summary>Constant Primaryoutput.</summary>
|
|
<unmanaged>MF_TOPONODE_PRIMARYOUTPUT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Rateless">
|
|
<summary>Constant Rateless.</summary>
|
|
<unmanaged>MF_TOPONODE_RATELESS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.SequenceElementid">
|
|
<summary>Constant SequenceElementid.</summary>
|
|
<unmanaged>MF_TOPONODE_SEQUENCE_ELEMENTID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Source">
|
|
<summary>Constant Source.</summary>
|
|
<unmanaged>MF_TOPONODE_SOURCE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.StreamDescriptor">
|
|
<summary>Constant StreamDescriptor.</summary>
|
|
<unmanaged>MF_TOPONODE_STREAM_DESCRIPTOR</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Streamid">
|
|
<summary>Constant Streamid.</summary>
|
|
<unmanaged>MF_TOPONODE_STREAMID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.TransformObjectid">
|
|
<summary>Constant TransformObjectid.</summary>
|
|
<unmanaged>MF_TOPONODE_TRANSFORM_OBJECTID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueId">
|
|
<summary>Constant WorkqueueId.</summary>
|
|
<unmanaged>MF_TOPONODE_WORKQUEUE_ID</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueItemPriority">
|
|
<summary>Constant WorkqueueItemPriority.</summary>
|
|
<unmanaged>MF_TOPONODE_WORKQUEUE_ITEM_PRIORITY</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueMmcssClass">
|
|
<summary>Constant WorkqueueMmcssClass.</summary>
|
|
<unmanaged>MF_TOPONODE_WORKQUEUE_MMCSS_CLASS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueMmcssPriority">
|
|
<summary>Constant WorkqueueMmcssPriority.</summary>
|
|
<unmanaged>MF_TOPONODE_WORKQUEUE_MMCSS_PRIORITY</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueMmcssTaskid">
|
|
<summary>Constant WorkqueueMmcssTaskid.</summary>
|
|
<unmanaged>MF_TOPONODE_WORKQUEUE_MMCSS_TASKID</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TranscodeAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.TranscodeAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeAdjustProfile">
|
|
<summary>Constant TranscodeAdjustProfile.</summary>
|
|
<unmanaged>MF_TRANSCODE_ADJUST_PROFILE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype">
|
|
<summary>Constant TranscodeContainertype.</summary>
|
|
<unmanaged>MF_TRANSCODE_CONTAINERTYPE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeDonotInsertEncoder">
|
|
<summary>Constant TranscodeDonotInsertEncoder.</summary>
|
|
<unmanaged>MF_TRANSCODE_DONOT_INSERT_ENCODER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeEncodingprofile">
|
|
<summary>Constant TranscodeEncodingprofile.</summary>
|
|
<unmanaged>MF_TRANSCODE_ENCODINGPROFILE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeQualityvsspeed">
|
|
<summary>Constant TranscodeQualityvsspeed.</summary>
|
|
<unmanaged>MF_TRANSCODE_QUALITYVSSPEED</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeSkipMetadataTransfer">
|
|
<summary>Constant TranscodeSkipMetadataTransfer.</summary>
|
|
<unmanaged>MF_TRANSCODE_SKIP_METADATA_TRANSFER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeTopologymode">
|
|
<summary>Constant TranscodeTopologymode.</summary>
|
|
<unmanaged>MF_TRANSCODE_TOPOLOGYMODE</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TransformAttributeKeys">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.MediaFoundation.TransformAttributeKeys']/*"/>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.ActivateMftLocked">
|
|
<summary>Constant ActivateMftLocked.</summary>
|
|
<unmanaged>MF_ACTIVATE_MFT_LOCKED</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.DisableLocallyRegisteredPlugins">
|
|
<summary>Constant DisableLocallyRegisteredPlugins.</summary>
|
|
<unmanaged>MF_DISABLE_LOCALLY_REGISTERED_PLUGINS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.Enable3dvideoOutput">
|
|
<summary>Constant Enable3dvideoOutput.</summary>
|
|
<unmanaged>MF_ENABLE_3DVIDEO_OUTPUT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.BuffersPerSample">
|
|
<summary>Constant BuffersPerSample.</summary>
|
|
<unmanaged>MF_SA_BUFFERS_PER_SAMPLE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.D3DAware">
|
|
<summary>Constant D3DAware.</summary>
|
|
<unmanaged>MF_SA_D3D_AWARE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.D3D11Aware">
|
|
<summary>Constant D3D11Aware.</summary>
|
|
<unmanaged>MF_SA_D3D11_AWARE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.D3D11Bindflags">
|
|
<summary>Constant D3D11Bindflags.</summary>
|
|
<unmanaged>MF_SA_D3D11_BINDFLAGS</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.D3D11Usage">
|
|
<summary>Constant D3D11Usage.</summary>
|
|
<unmanaged>MF_SA_D3D11_USAGE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.TransformAsync">
|
|
<summary>Constant TransformAsync.</summary>
|
|
<unmanaged>MF_TRANSFORM_ASYNC</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.TransformAsyncUnlock">
|
|
<summary>Constant TransformAsyncUnlock.</summary>
|
|
<unmanaged>MF_TRANSFORM_ASYNC_UNLOCK</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.TransformCategoryAttribute">
|
|
<summary>Constant TransformCategoryAttribute.</summary>
|
|
<unmanaged>MF_TRANSFORM_CATEGORY_Attribute</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.TransformFlagsAttribute">
|
|
<summary>Constant TransformFlagsAttribute.</summary>
|
|
<unmanaged>MF_TRANSFORM_FLAGS_Attribute</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftCodecMeritAttribute">
|
|
<summary>Constant MftCodecMeritAttribute.</summary>
|
|
<unmanaged>MFT_CODEC_MERIT_Attribute</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftConnectedStreamAttribute">
|
|
<summary>Constant MftConnectedStreamAttribute.</summary>
|
|
<unmanaged>MFT_CONNECTED_STREAM_ATTRIBUTE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftConnectedToHwStream">
|
|
<summary>Constant MftConnectedToHwStream.</summary>
|
|
<unmanaged>MFT_CONNECTED_TO_HW_STREAM</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftDecoderExposeOutputTypesInNativeOrder">
|
|
<summary>Constant MftDecoderExposeOutputTypesInNativeOrder.</summary>
|
|
<unmanaged>MFT_DECODER_EXPOSE_OUTPUT_TYPES_IN_NATIVE_ORDER</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftDecoderFinalVideoResolutionHint">
|
|
<summary>Constant MftDecoderFinalVideoResolutionHint.</summary>
|
|
<unmanaged>MFT_DECODER_FINAL_VIDEO_RESOLUTION_HINT</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftEnumHardwareUrlAttribute">
|
|
<summary>Constant MftEnumHardwareUrlAttribute.</summary>
|
|
<unmanaged>MFT_ENUM_HARDWARE_URL_Attribute</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftEnumHardwareVendorIdAttribute">
|
|
<summary>Constant MftEnumHardwareVendorIdAttribute.</summary>
|
|
<unmanaged>MFT_ENUM_HARDWARE_VENDOR_ID_Attribute</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftEnumTranscodeOnlyAttribute">
|
|
<summary>Constant MftEnumTranscodeOnlyAttribute.</summary>
|
|
<unmanaged>MFT_ENUM_TRANSCODE_ONLY_ATTRIBUTE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftFieldofuseUnlockAttribute">
|
|
<summary>Constant MftFieldofuseUnlockAttribute.</summary>
|
|
<unmanaged>MFT_FIELDOFUSE_UNLOCK_Attribute</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftFriendlyNameAttribute">
|
|
<summary>Constant MftFriendlyNameAttribute.</summary>
|
|
<unmanaged>MFT_FRIENDLY_NAME_Attribute</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftHwTimestampWithQpcAttribute">
|
|
<summary>Constant MftHwTimestampWithQpcAttribute.</summary>
|
|
<unmanaged>MFT_HW_TIMESTAMP_WITH_QPC_Attribute</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftInputTypesAttributes">
|
|
<summary>Constant MftInputTypesAttributes.</summary>
|
|
<unmanaged>MFT_INPUT_TYPES_Attributes</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftOutputTypesAttributes">
|
|
<summary>Constant MftOutputTypesAttributes.</summary>
|
|
<unmanaged>MFT_OUTPUT_TYPES_Attributes</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftPreferredEncoderProfile">
|
|
<summary>Constant MftPreferredEncoderProfile.</summary>
|
|
<unmanaged>MFT_PREFERRED_ENCODER_PROFILE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftPreferredOutputtypeAttribute">
|
|
<summary>Constant MftPreferredOutputtypeAttribute.</summary>
|
|
<unmanaged>MFT_PREFERRED_OUTPUTTYPE_Attribute</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftProcessLocalAttribute">
|
|
<summary>Constant MftProcessLocalAttribute.</summary>
|
|
<unmanaged>MFT_PROCESS_LOCAL_Attribute</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftSupport3dvideo">
|
|
<summary>Constant MftSupport3dvideo.</summary>
|
|
<unmanaged>MFT_SUPPORT_3DVIDEO</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftSupportDynamicFormatChange">
|
|
<summary>Constant MftSupportDynamicFormatChange.</summary>
|
|
<unmanaged>MFT_SUPPORT_DYNAMIC_FORMAT_CHANGE</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TransformAttributeKeys.MftTransformClsidAttribute">
|
|
<summary>Constant MftTransformClsidAttribute.</summary>
|
|
<unmanaged>MFT_TRANSFORM_CLSID_Attribute</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Activate">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates the object associated with this activation object. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Some Microsoft Media Foundation objects must be shut down before being released. If so, the caller is responsible for shutting down the object that is returned in <em>ppv</em>. To shut down the object, do one of the following:</p><ul> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ShutdownObject"/></strong> on the activation object, or</li> <li>Call the object-specific shutdown method. This method will depend on the type of object. Possibilities include:<ul> <li>Media sources: Call <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Shutdown"/></strong>.</li> <li>Media sinks: Call <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.Shutdown"/></strong>.</li> <li>Any object that supports the <strong><see cref="T:SharpDX.MediaFoundation.Shutdownable"/></strong> interface: Call <strong><see cref="M:SharpDX.MediaFoundation.Shutdownable.Shutdown"/></strong>.</li> </ul> </li> </ul><p>The <strong><see cref="M:SharpDX.MediaFoundation.Activate.ShutdownObject"/></strong> method is generic to all object types. If the object does not require a shutdown method, <strong>ShutdownObject</strong> succeeds and has no effect. If you do not know the specific shutdown method for the object (or do not know the object type), call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ShutdownObject"/></strong>.</p><p> After the first call to <strong>ActivateObject</strong>, subsequent calls return a reference to the same instance, until the client calls either <strong>ShutdownObject</strong> or <strong><see cref="M:SharpDX.MediaFoundation.Activate.DetachObject"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFActivate']/*"/>
|
|
<msdn-id>ms694292</msdn-id>
|
|
<unmanaged>IMFActivate</unmanaged>
|
|
<unmanaged-short>IMFActivate</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaAttributes">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Provides a generic way to store key/value pairs on an object. The keys are <strong><see cref="T:System.Guid"/></strong>s, and the values can be any of the following data types: <strong>UINT32</strong>, <strong>UINT64</strong>, <strong>double</strong>, <strong><see cref="T:System.Guid"/></strong>, wide-character string, byte array, or <strong><see cref="T:SharpDX.ComObject"/></strong> reference. The standard implementation of this interface holds a thread lock while values are added, deleted, or retrieved.</p><p>For a list of predefined attribute <strong><see cref="T:System.Guid"/></strong>s, see Media Foundation Attributes. Each attribute <strong><see cref="T:System.Guid"/></strong> has an expected data type. The various "set" methods in <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> do not validate the type against the attribute <strong><see cref="T:System.Guid"/></strong>. It is the application's responsibility to set the correct type for the attribute.</p><p>To create an empty attribute store, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAttributes(SharpDX.MediaFoundation.MediaAttributes,System.Int32)"/></strong>.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes']/*"/>
|
|
<msdn-id>ms704598</msdn-id>
|
|
<unmanaged>IMFAttributes</unmanaged>
|
|
<unmanaged-short>IMFAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaAttributes"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaAttributes">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaAttributes"/>. (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.MediaFoundation.MediaAttributes.GetItem(System.Guid,System.IntPtr)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="guidKey">No documentation.</param>
|
|
<param name="valueRef">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='IMFAttributes::GetItem']/*"/>
|
|
<unmanaged>HRESULT IMFAttributes::GetItem([In] const GUID& guidKey,[In] void* pValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetItemType(System.Guid)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="guidKey">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='IMFAttributes::GetItemType']/*"/>
|
|
<unmanaged>HRESULT IMFAttributes::GetItemType([In] const GUID& guidKey,[Out] MF_ATTRIBUTE_TYPE* pType)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetItemType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.CompareItem(System.Guid,SharpDX.Win32.Variant)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="guidKey">No documentation.</param>
|
|
<param name="value">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='IMFAttributes::CompareItem']/*"/>
|
|
<unmanaged>HRESULT IMFAttributes::CompareItem([In] const GUID& guidKey,[In] const PROPVARIANT& Value,[Out] BOOL* pbResult)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::CompareItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Compare(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.AttributesMatchType)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Compares the attributes on this object with the attributes on another object.</p>
|
|
</summary>
|
|
<param name="theirsRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of the object to compare with this object.</p> </dd></param>
|
|
<param name="matchType"><dd> <p>Member of the <strong><see cref="T:SharpDX.MediaFoundation.AttributesMatchType"/></strong> enumeration, specifying the type of comparison to make.</p> </dd></param>
|
|
<returns><dd> <p>Receives a Boolean value. The value is <strong>TRUE</strong> if the two sets of attributes match in the way specified by the <em>MatchType</em> parameter. Otherwise, the value is <strong><see cref="F:SharpDX.Result.False"/></strong>.</p> </dd></returns>
|
|
<remarks>
|
|
<p>If <em>pThis</em> is the object whose <strong>Compare</strong> method is called, and <em>pTheirs</em> is the object passed in as the <em>pTheirs</em> parameter, the following comparisons are defined by <em>MatchType</em>.</p><table> <tr><th>Match type</th><th>Returns <strong>TRUE</strong> if and only if</th></tr> <tr><td><strong><see cref="F:SharpDX.MediaFoundation.AttributesMatchType.OurItems"/></strong></td><td>For every attribute in <em>pThis</em>, an attribute with the same key and value exists in <em>pTheirs</em>.</td></tr> <tr><td><strong><see cref="F:SharpDX.MediaFoundation.AttributesMatchType.TheirItems"/></strong></td><td>For every attribute in <em>pTheirs</em>, an attribute with the same key and value exists in <em>pThis</em>.</td></tr> <tr><td><strong><see cref="F:SharpDX.MediaFoundation.AttributesMatchType.AllItems"/></strong></td><td>The key/value pairs are identical in both objects.</td></tr> <tr><td><strong><see cref="F:SharpDX.MediaFoundation.AttributesMatchType.Intersection"/></strong></td><td>Take the intersection of the keys in <em>pThis</em> and the keys in <em>pTheirs</em>. The values associated with those keys are identical in both <em>pThis</em> and <em>pTheirs</em>.</td></tr> <tr><td><strong><see cref="F:SharpDX.MediaFoundation.AttributesMatchType.Smaller"/></strong></td><td>Take the object with the smallest number of attributes. For every attribute in that object, an attribute with the same key and value exists in the other object.</td></tr> </table><p>?</p><p>The <em>pTheirs</em> and <em>pbResult</em> parameters must not be <strong><c>null</c></strong>. If either parameter is <strong><c>null</c></strong>, an access violation occurs.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::Compare']/*"/>
|
|
<msdn-id>bb970349</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::Compare([In, Optional] IMFAttributes* pTheirs,[In] MF_ATTRIBUTES_MATCH_TYPE MatchType,[Out] BOOL* pbResult)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::Compare</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetInt(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a <strong>UINT32</strong> value associated with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.UInt32"/></strong>.</p> </dd></param>
|
|
<returns><dd> <p>Receives a <strong>UINT32</strong> value. If the key is found and the data type is <strong>UINT32</strong>, the method copies the value into this parameter. Otherwise, the original value of this parameter is not changed.</p> </dd></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetUINT32']/*"/>
|
|
<msdn-id>bb970551</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetUINT32([In] const GUID& guidKey,[Out] unsigned int* punValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetUINT32</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetLong(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a <strong>UINT64</strong> value associated with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.UInt64"/></strong>.</p> </dd></param>
|
|
<returns><dd> <p>Receives a <strong>UINT64</strong> value. If the key is found and the data type is <strong>UINT64</strong>, the method copies the value into this parameter. Otherwise, the original value of this parameter is not changed.</p> </dd></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetUINT64']/*"/>
|
|
<msdn-id>bb970569</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetUINT64([In] const GUID& guidKey,[Out] unsigned longlong* punValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetUINT64</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetDouble(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a <strong>double</strong> value associated with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.Double"/></strong>.</p> </dd></param>
|
|
<returns><dd> <p>Receives a <strong>double</strong> value. If the key is found and the data type is <strong>double</strong>, the method copies the value into this parameter. Otherwise, the original value of this parameter is not changed.</p> </dd></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetDouble']/*"/>
|
|
<msdn-id>bb970418</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetDouble([In] const GUID& guidKey,[Out] double* pfValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetDouble</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetGUID(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a <see cref="T:System.Guid"/> value associated with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.Guid"/></strong>.</p> </dd></param>
|
|
<returns><dd> <p>Receives a <see cref="T:System.Guid"/> value. If the key is found and the data type is <see cref="T:System.Guid"/>, the method copies the value into this parameter. Otherwise, the original value of this parameter is not changed.</p> </dd></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetGUID']/*"/>
|
|
<msdn-id>bb970426</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetGUID([In] const GUID& guidKey,[Out] GUID* pguidValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetGUID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetStringLength(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the length of a string value associated with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.String"/></strong>.</p> </dd></param>
|
|
<returns><dd> <p>If the key is found and the value is a string type, this parameter receives the number of characters in the string, not including the terminating <strong><c>null</c></strong> character. To get the string value, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetString(System.Guid,System.IntPtr,System.Int32,System.IntPtr)"/></strong>.</p> </dd></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetStringLength']/*"/>
|
|
<msdn-id>bb970425</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetStringLength([In] const GUID& guidKey,[Out] unsigned int* pcchLength)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetStringLength</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetString(System.Guid,System.IntPtr,System.Int32,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a wide-character string associated with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.String"/></strong>.</p> </dd></param>
|
|
<param name="wszValueRef"><dd> <p>Pointer to a wide-character array allocated by the caller. The array must be large enough to hold the string, including the terminating <strong><c>null</c></strong> character. If the key is found and the value is a string type, the method copies the string into this buffer. To find the length of the string, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetStringLength(System.Guid)"/></strong>.</p> </dd></param>
|
|
<param name="cchBufSize"><dd> <p>The size of the <em>pwszValue</em> array, in characters. This value includes the terminating <c>null</c> character.</p> </dd></param>
|
|
<param name="cchLengthRef"><dd> <p>Receives the number of characters in the string, excluding the terminating <strong><c>null</c></strong> character. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_OUTOFMEMORY</strong></dt> </dl> </td><td> <p>The length of the string is too large to fit in a <strong>UINT32</strong> value.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOT_SUFFICIENT_BUFFER</strong></dt> </dl> </td><td> <p>The buffer is not large enough to hold the string.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ATTRIBUTENOTFOUND</strong></dt> </dl> </td><td> <p>The specified key was not found.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDTYPE</strong></dt> </dl> </td><td> <p>The attribute value is not a string.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You can also use the <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetAllocatedString(System.Guid,System.IntPtr,System.Int32@)"/></strong> method, which allocates the buffer to hold the string.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetString']/*"/>
|
|
<msdn-id>bb970430</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetString([In] const GUID& guidKey,[Out, Buffer] wchar_t* pwszValue,[In] unsigned int cchBufSize,[InOut, Optional] unsigned int* pcchLength)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetString</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetAllocatedString(System.Guid,System.IntPtr,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets a wide-character string associated with a key. This method allocates the memory for the string. </p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p>A <see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.String"/></strong>. </p> </dd></param>
|
|
<param name="wszValueOut"><dd> <p>If the key is found and the value is a string type, this parameter receives a copy of the string. The caller must free the memory for the string by calling <strong>CoTaskMemFree</strong>. </p> </dd></param>
|
|
<param name="cchLengthRef"><dd> <p> Receives the number of characters in the string, excluding the terminating <strong><c>null</c></strong> character. This parameter must not be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ATTRIBUTENOTFOUND</strong></dt> </dl> </td><td> <p> The specified key was not found. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDTYPE</strong></dt> </dl> </td><td> <p> The attribute value is not a string. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To copy a string value into a caller-allocated buffer, use the <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetString(System.Guid,System.IntPtr,System.Int32,System.IntPtr)"/></strong> method.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul><p><strong>Note</strong>??An earlier version of the documentation incorrectly stated that the <em>pcchLength</em> parameter can be <strong><c>null</c></strong>. Setting this parameter to <strong><c>null</c></strong> might succeed in some cases, but is not guaranteed. The caller must pass a non-<strong><c>null</c></strong> reference for this parameter.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetAllocatedString']/*"/>
|
|
<msdn-id>bb970406</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetAllocatedString([In] const GUID& guidKey,[Out, Buffer, Optional] wchar_t** ppwszValue,[Out] unsigned int* pcchLength)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetAllocatedString</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetBlobSize(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the length of a byte array associated with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.Blob"/></strong>.</p> </dd></param>
|
|
<returns><dd> <p>If the key is found and the value is a byte array, this parameter receives the size of the array, in bytes.</p> </dd></returns>
|
|
<remarks>
|
|
<p>To get the byte array, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetBlob(System.Guid,System.IntPtr,System.Int32,System.IntPtr)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetBlobSize']/*"/>
|
|
<msdn-id>bb970459</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetBlobSize([In] const GUID& guidKey,[Out] unsigned int* pcbBlobSize)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetBlobSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetBlob(System.Guid,System.IntPtr,System.Int32,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a byte array associated with a key. This method copies the array into a caller-allocated buffer.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.Blob"/></strong>.</p> </dd></param>
|
|
<param name="bufRef"><dd> <p>Pointer to a buffer allocated by the caller. If the key is found and the value is a byte array, the method copies the array into this buffer. To find the required size of the buffer, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetBlobSize(System.Guid)"/></strong>.</p> </dd></param>
|
|
<param name="cbBufSize"><dd> <p>The size of the <em>pBuf</em> buffer, in bytes.</p> </dd></param>
|
|
<param name="cbBlobSizeRef"><dd> <p>Receives the size of the byte array. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_NOT_SUFFICIENT_BUFFER</strong></strong></dt> </dl> </td><td> <p>The buffer is not large enough to the array.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_ATTRIBUTENOTFOUND</strong></strong></dt> </dl> </td><td> <p>The specified key was not found.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDTYPE</strong></strong></dt> </dl> </td><td> <p>The attribute value is not a byte array.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You can also use the <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetAllocatedBlob(System.Guid,System.Byte[],System.Int32@)"/></strong> method, which allocates the buffer to hold the byte array.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetBlob']/*"/>
|
|
<msdn-id>bb970421</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetBlob([In] const GUID& guidKey,[In] void* pBuf,[In] unsigned int cbBufSize,[InOut, Optional] unsigned int* pcbBlobSize)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetBlob</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetAllocatedBlob(System.Guid,System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a byte array associated with a key. This method allocates the memory for the array.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.Blob"/></strong>.</p> </dd></param>
|
|
<param name="bufOut"><dd> <p>If the key is found and the value is a byte array, this parameter receives a copy of the array. The caller must free the memory for the array by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbSizeRef"><dd> <p>Receives the size of the array, in bytes.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ATTRIBUTENOTFOUND</strong></dt> </dl> </td><td> <p>The specified key was not found.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDTYPE</strong></dt> </dl> </td><td> <p>The attribute value is not a byte array.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To copy a byte array value into a caller-allocated buffer, use the <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetBlob(System.Guid,System.IntPtr,System.Int32,System.IntPtr)"/></strong> method.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetAllocatedBlob']/*"/>
|
|
<msdn-id>bb970382</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetAllocatedBlob([In] const GUID& guidKey,[Out, Buffer, Optional] unsigned char** ppBuf,[Out] unsigned int* pcbSize)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetAllocatedBlob</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetUnknown(System.Guid,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves an interface reference associated with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies which value to retrieve. The attribute type must be <strong><see cref="F:SharpDX.MediaFoundation.AttributeType.IUnknown"/></strong>.</p> </dd></param>
|
|
<param name="riid"><dd> <p>Interface identifier (IID) of the interface to retrieve.</p> </dd></param>
|
|
<param name="vOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOINTERFACE</strong></dt> </dl> </td><td> <p>The attribute value is an <strong><see cref="T:SharpDX.ComObject"/></strong> reference but does not support requested interface.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ATTRIBUTENOTFOUND</strong></dt> </dl> </td><td> <p>The specified key was not found.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDTYPE</strong></dt> </dl> </td><td> <p>The attribute value is not an <strong><see cref="T:SharpDX.ComObject"/></strong> reference.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetUnknown']/*"/>
|
|
<msdn-id>bb970481</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetUnknown([In] const GUID& guidKey,[In] const GUID& riid,[Out] void** ppv)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetUnknown</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Set(System.Guid,SharpDX.Win32.Variant)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Adds an attribute value with a specified key. </p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p> A <see cref="T:System.Guid"/> that identifies the value to set. If this key already exists, the method overwrites the old value. </p> </dd></param>
|
|
<param name="value"><dd> <p> A <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that contains the attribute value. The method copies the value. The <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type must be one of the types listed in the <strong><see cref="T:SharpDX.MediaFoundation.AttributeType"/></strong> enumeration. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_OUTOFMEMORY</strong></dt> </dl> </td><td> <p> Insufficient memory. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDTYPE</strong></dt> </dl> </td><td> <p> Invalid attribute type. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> This method checks whether the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type is one of the attribute types defined in <strong><see cref="T:SharpDX.MediaFoundation.AttributeType"/></strong>, and fails if an unsupported type is used. However, this method does not check whether the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> is the correct type for the specified attribute <see cref="T:System.Guid"/>. (There is no programmatic way to associate attribute GUIDs with property types.) For a list of Media Foundation attributes and their data types, see Media Foundation Attributes. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::SetItem']/*"/>
|
|
<msdn-id>bb970346</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::SetItem([In] const GUID& guidKey,[In] const PROPVARIANT& Value)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::SetItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.DeleteItem(System.Guid)">
|
|
<summary>
|
|
<p>Removes a key/value pair from the object's attribute list. </p> <see cref="T:SharpDX.Result"/> DeleteItem( REFGUID guidKey
|
|
);
|
|
<p></p>Parameters <p> guidKey </p> <p>[in] <see cref="T:System.Guid"/> that identifies the value to delete.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr></table> <p>If the specified key does not exist, the method returns <see cref="F:SharpDX.Result.Ok"/>.</p> <p> Client: Requires Windows Vista.</p> <p> Header: Defined in mfobjects.h; include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFAttributes Interface
|
|
</summary>
|
|
<param name="guidKey">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='IMFAttributes::DeleteItem']/*"/>
|
|
<msdn-id>ms701993</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::DeleteItem([In] const GUID& guidKey)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::DeleteItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.DeleteAllItems">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Removes all key/value pairs from the object's attribute list.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::DeleteAllItems']/*"/>
|
|
<msdn-id>ms700200</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::DeleteAllItems()</unmanaged>
|
|
<unmanaged-short>IMFAttributes::DeleteAllItems</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Set(System.Guid,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Associates a <strong>UINT32</strong> value with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies the value to set. If this key already exists, the method overwrites the old value.</p> </dd></param>
|
|
<param name="unValue"><dd> <p>New value for this key.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To retrieve the <strong>UINT32</strong> value, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetInt(System.Guid)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::SetUINT32']/*"/>
|
|
<msdn-id>bb970467</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::SetUINT32([In] const GUID& guidKey,[In] unsigned int unValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::SetUINT32</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Set(System.Guid,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Associates a <strong>UINT64</strong> value with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies the value to set. If this key already exists, the method overwrites the old value.</p> </dd></param>
|
|
<param name="unValue"><dd> <p>New value for this key.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To retrieve the <strong>UINT64</strong> value, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetLong(System.Guid)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::SetUINT64']/*"/>
|
|
<msdn-id>bb970439</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::SetUINT64([In] const GUID& guidKey,[In] unsigned longlong unValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::SetUINT64</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Set(System.Guid,System.Double)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Associates a <strong>double</strong> value with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies the value to set. If this key already exists, the method overwrites the old value.</p> </dd></param>
|
|
<param name="fValue"><dd> <p>New value for this key.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To retrieve the double value, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetDouble(System.Guid)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::SetDouble']/*"/>
|
|
<msdn-id>bb970505</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::SetDouble([In] const GUID& guidKey,[In] double fValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::SetDouble</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Set(System.Guid,System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Associates a <see cref="T:System.Guid"/> value with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies the value to set. If this key already exists, the method overwrites the old value.</p> </dd></param>
|
|
<param name="guidValue"><dd> <p>New value for this key.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_OUTOFMEMORY</strong></dt> </dl> </td><td> <p>Insufficient memory.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To retrieve the <see cref="T:System.Guid"/> value, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetGUID(System.Guid)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::SetGUID']/*"/>
|
|
<msdn-id>bb970530</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::SetGUID([In] const GUID& guidKey,[In] const GUID& guidValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::SetGUID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Set(System.Guid,System.String)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Associates a wide-character string with a key.</p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p><see cref="T:System.Guid"/> that identifies the value to set. If this key already exists, the method overwrites the old value.</p> </dd></param>
|
|
<param name="wszValue"><dd> <p>Null-terminated wide-character string to associate with this key. The method stores a copy of the string.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To retrieve the string, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetString(System.Guid,System.IntPtr,System.Int32,System.IntPtr)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetAllocatedString(System.Guid,System.IntPtr,System.Int32@)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::SetString']/*"/>
|
|
<msdn-id>bb970404</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::SetString([In] const GUID& guidKey,[In] const wchar_t* wszValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::SetString</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.SetBlob(System.Guid,System.IntPtr,System.Int32)">
|
|
<summary>
|
|
<p>Associates a byte array with a key. </p> <see cref="T:SharpDX.Result"/> SetString( REFGUID guidKey, const UINT8* pBuf, UINT32 cbBufSize
|
|
);<p></p>Parameters <p> guidKey </p> <p>[in] <see cref="T:System.Guid"/> that identifies the value to set. If this key already exists, the method overwrites the old value.</p> <p> pBuf </p> <p>[in] Pointer to a byte array to associate with this key. The method stores a copy of the array.</p> <p> cbBufSize </p> <p>[in] Size of the array, in bytes.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p>E_OUTOFMEMORY</p> </td> <td> <p>Insufficient memory.</p> </td> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr></table> <p> Client: Requires Windows Vista.</p> <p> Header: Defined in mfobjects.h; include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFAttributes Interface
|
|
</summary>
|
|
<param name="guidKey">No documentation.</param>
|
|
<param name="bufRef">No documentation.</param>
|
|
<param name="cbBufSize">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='IMFAttributes::SetBlob']/*"/>
|
|
<msdn-id>ms694230</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::SetBlob([In] const GUID& guidKey,[In] const void* pBuf,[In] unsigned int cbBufSize)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::SetBlob</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Set(System.Guid,SharpDX.ComObject)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="guidKey">No documentation.</param>
|
|
<param name="unknownRef">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='IMFAttributes::SetUnknown']/*"/>
|
|
<unmanaged>HRESULT IMFAttributes::SetUnknown([In] const GUID& guidKey,[In, Optional] IUnknown* pUnknown)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::SetUnknown</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.LockStore">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Locks the attribute store so that no other thread can access it. If the attribute store is already locked by another thread, this method blocks until the other thread unlocks the object. After calling this method, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.UnlockStore"/></strong> to unlock the object.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method can cause a deadlock if a thread that calls <strong>LockStore</strong> waits on a thread that calls any other <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> methods on the same object.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::LockStore']/*"/>
|
|
<msdn-id>ms698926</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::LockStore()</unmanaged>
|
|
<unmanaged-short>IMFAttributes::LockStore</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.UnlockStore">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Unlocks the attribute store after a call to the <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.LockStore"/></strong> method. While the object is unlocked, multiple threads can access the object's attributes.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::UnlockStore']/*"/>
|
|
<msdn-id>ms697545</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::UnlockStore()</unmanaged>
|
|
<unmanaged-short>IMFAttributes::UnlockStore</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetCount(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of attributes that are set on this object.</p>
|
|
</summary>
|
|
<param name="cItemsRef"><dd> <p>Receives the number of attributes. This parameter must not be <strong><c>null</c></strong>. If this parameter is <strong><c>null</c></strong>, an access violation occurs.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To enumerate all of the attributes, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetItemByIndex(System.Int32,System.Guid@,System.IntPtr)"/></strong> for each index value.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetCount']/*"/>
|
|
<msdn-id>bb970413</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetCount([Out] unsigned int* pcItems)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetItemByIndex(System.Int32,System.Guid@,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves an attribute at the specified index.</p>
|
|
</summary>
|
|
<param name="unIndex"><dd> <p>Index of the attribute to retrieve. To get the number of attributes, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetCount(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<param name="guidKeyRef"><dd> <p>Receives the <see cref="T:System.Guid"/> that identifies this attribute.</p> </dd></param>
|
|
<param name="valueRef"><dd> <p>Pointer to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that receives the value. This parameter can be <strong><c>null</c></strong>. If it is not <strong><c>null</c></strong>, the method fills the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> with a copy of the attribute value. Call <strong>PropVariantClear</strong> to free the memory allocated by this method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid index.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To enumerate all of an object's attributes in a thread-safe way, do the following:</p><ol> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.LockStore"/></strong> to prevent another thread from adding or deleting attributes.</p> </li> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetCount(System.Int32@)"/></strong> to find the number of attributes.</p> </li> <li> <p>Call <strong>GetItemByIndex</strong> to get each attribute by index.</p> </li> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.UnlockStore"/></strong> to unlock the attribute store.</p> </li> </ol><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetItemByIndex']/*"/>
|
|
<msdn-id>bb970331</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetItemByIndex([In] unsigned int unIndex,[Out] GUID* pguidKey,[InOut, Optional] PROPVARIANT* pValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetItemByIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.CopyAllItems(SharpDX.MediaFoundation.MediaAttributes)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Copies all of the attributes from this object into another attribute store. </p>
|
|
</summary>
|
|
<param name="destRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of the attribute store that receives the copy. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This method deletes all of the attributes originally stored in <em>pDest</em>. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::CopyAllItems']/*"/>
|
|
<msdn-id>bb970330</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::CopyAllItems([In, Optional] IMFAttributes* pDest)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::CopyAllItems</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.#ctor(System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaAttributes"/> class.
|
|
</summary>
|
|
<param name="initialSizeInBytes">The initial number of elements allocated for the attribute store. The attribute store grows as needed. Default is 0</param>
|
|
<remarks>
|
|
<p>Attributes are used throughout Microsoft Media Foundation to configure objects, describe media formats, query object properties, and other purposes. For more information, see Attributes in Media Foundation.</p><p>For a complete list of all the defined attribute GUIDs in Media Foundation, see Media Foundation Attributes.</p>
|
|
</remarks>
|
|
<msdn-id>ms701878</msdn-id>
|
|
<unmanaged>HRESULT MFCreateAttributes([Out] IMFAttributes** ppMFAttributes,[In] unsigned int cInitialSize)</unmanaged>
|
|
<unmanaged-short>MFCreateAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Get(System.Guid)">
|
|
<summary>
|
|
Gets an item value
|
|
</summary>
|
|
<param name="guidKey">GUID of the key.</param>
|
|
<returns>The value associated to this key.</returns>
|
|
<msdn-id>ms704598</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetItem([In] const GUID& guidKey,[In] void* pValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.GetByIndex(System.Int32,System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves an attribute at the specified index.</p>
|
|
</summary>
|
|
<param name="index"><dd> <p>Index of the attribute to retrieve. To get the number of attributes, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetCount(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<param name="guidKey"><dd> <p>Receives the <see cref="T:System.Guid"/> that identifies this attribute.</p> </dd></param>
|
|
<returns>The value associated to this index</returns>
|
|
<remarks>
|
|
<p>To enumerate all of an object's attributes in a thread-safe way, do the following:</p><ol> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.LockStore"/></strong> to prevent another thread from adding or deleting attributes.</p> </li> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetCount(System.Int32@)"/></strong> to find the number of attributes.</p> </li> <li> <p>Call <strong>GetItemByIndex</strong> to get each attribute by index.</p> </li> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.UnlockStore"/></strong> to unlock the attribute store.</p> </li> </ol><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<msdn-id>bb970331</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetItemByIndex([In] unsigned int unIndex,[Out] GUID* pguidKey,[InOut, Optional] PROPVARIANT* pValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetItemByIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Get``1(System.Guid)">
|
|
<summary>
|
|
Gets an item value
|
|
</summary>
|
|
<param name="guidKey">GUID of the key.</param>
|
|
<returns>The value associated to this key.</returns>
|
|
<msdn-id>ms704598</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetItem([In] const GUID& guidKey,[In] void* pValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Get``1(SharpDX.MediaFoundation.MediaAttributeKey{``0})">
|
|
<summary>
|
|
Gets an item value
|
|
</summary>
|
|
<param name="guidKey">GUID of the key.</param>
|
|
<returns>The value associated to this key.</returns>
|
|
<msdn-id>ms704598</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::GetItem([In] const GUID& guidKey,[In] void* pValue)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::GetItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Set``1(System.Guid,``0)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Adds an attribute value with a specified key. </p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p> A <see cref="T:System.Guid"/> that identifies the value to set. If this key already exists, the method overwrites the old value. </p> </dd></param>
|
|
<param name="value"><dd> <p> A <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that contains the attribute value. The method copies the value. The <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type must be one of the types listed in the <strong><see cref="T:SharpDX.MediaFoundation.AttributeType"/></strong> enumeration. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_OUTOFMEMORY</strong></dt> </dl> </td><td> <p> Insufficient memory. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDTYPE</strong></dt> </dl> </td><td> <p> Invalid attribute type. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> This method checks whether the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type is one of the attribute types defined in <strong><see cref="T:SharpDX.MediaFoundation.AttributeType"/></strong>, and fails if an unsupported type is used. However, this method does not check whether the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> is the correct type for the specified attribute <see cref="T:System.Guid"/>. (There is no programmatic way to associate attribute GUIDs with property types.) For a list of Media Foundation attributes and their data types, see Media Foundation Attributes. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<msdn-id>bb970346</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::SetItem([In] const GUID& guidKey,[In] const PROPVARIANT& Value)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::SetItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributes.Set``1(SharpDX.MediaFoundation.MediaAttributeKey{``0},``0)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Adds an attribute value with a specified key. </p>
|
|
</summary>
|
|
<param name="guidKey"><dd> <p> A <see cref="T:System.Guid"/> that identifies the value to set. If this key already exists, the method overwrites the old value. </p> </dd></param>
|
|
<param name="value"><dd> <p> A <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that contains the attribute value. The method copies the value. The <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type must be one of the types listed in the <strong><see cref="T:SharpDX.MediaFoundation.AttributeType"/></strong> enumeration. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_OUTOFMEMORY</strong></dt> </dl> </td><td> <p> Insufficient memory. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDTYPE</strong></dt> </dl> </td><td> <p> Invalid attribute type. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> This method checks whether the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type is one of the attribute types defined in <strong><see cref="T:SharpDX.MediaFoundation.AttributeType"/></strong>, and fails if an unsupported type is used. However, this method does not check whether the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> is the correct type for the specified attribute <see cref="T:System.Guid"/>. (There is no programmatic way to associate attribute GUIDs with property types.) For a list of Media Foundation attributes and their data types, see Media Foundation Attributes. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<msdn-id>bb970346</msdn-id>
|
|
<unmanaged>HRESULT IMFAttributes::SetItem([In] const GUID& guidKey,[In] const PROPVARIANT& Value)</unmanaged>
|
|
<unmanaged-short>IMFAttributes::SetItem</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaAttributes.Count">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of attributes that are set on this object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To enumerate all of the attributes, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.GetItemByIndex(System.Int32,System.Guid@,System.IntPtr)"/></strong> for each index value.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAttributes::GetCount']/*"/>
|
|
<msdn-id>bb970413</msdn-id>
|
|
<unmanaged>GetCount</unmanaged>
|
|
<unmanaged-short>GetCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFAttributes::GetCount([Out] unsigned int* pcItems)</unmanaged>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Activate.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Activate"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Activate.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Activate">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Activate"/>. (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.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates the object associated with this activation object. </p>
|
|
</summary>
|
|
<param name="riid"><dd> <p> Interface identifier (IID) of the requested interface. </p> </dd></param>
|
|
<param name="vOut"><dd> <p> Receives a reference to the requested interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Some Microsoft Media Foundation objects must be shut down before being released. If so, the caller is responsible for shutting down the object that is returned in <em>ppv</em>. To shut down the object, do one of the following:</p><ul> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ShutdownObject"/></strong> on the activation object, or</li> <li>Call the object-specific shutdown method. This method will depend on the type of object. Possibilities include:<ul> <li>Media sources: Call <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Shutdown"/></strong>.</li> <li>Media sinks: Call <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.Shutdown"/></strong>.</li> <li>Any object that supports the <strong><see cref="T:SharpDX.MediaFoundation.Shutdownable"/></strong> interface: Call <strong><see cref="M:SharpDX.MediaFoundation.Shutdownable.Shutdown"/></strong>.</li> </ul> </li> </ul><p>The <strong><see cref="M:SharpDX.MediaFoundation.Activate.ShutdownObject"/></strong> method is generic to all object types. If the object does not require a shutdown method, <strong>ShutdownObject</strong> succeeds and has no effect. If you do not know the specific shutdown method for the object (or do not know the object type), call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ShutdownObject"/></strong>.</p><p> After the first call to <strong>ActivateObject</strong>, subsequent calls return a reference to the same instance, until the client calls either <strong>ShutdownObject</strong> or <strong><see cref="M:SharpDX.MediaFoundation.Activate.DetachObject"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFActivate::ActivateObject']/*"/>
|
|
<msdn-id>ms694292</msdn-id>
|
|
<unmanaged>HRESULT IMFActivate::ActivateObject([In] const GUID& riid,[Out] void** ppv)</unmanaged>
|
|
<unmanaged-short>IMFActivate::ActivateObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Activate.ShutdownObject">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Shuts down the created object.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If you create an object by calling <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong>, call <strong>ShutdownObject</strong> when you are done using the object.</p><p>The component that calls <strong>ActivateObject</strong>?not the component that creates the activation object?is responsible for calling <strong>ShutdownObject</strong>. For example, in a typical playback application, the application creates activation objects for the media sinks, but the Media Session calls <strong>ActivateObject</strong>. Therefore the Media Session, not the application, calls <strong>ShutdownObject</strong>.</p><p>After <strong>ShutdownObject</strong> is called, the activation object releases all of its internal references to the created object. If you call <strong>ActivateObject</strong> again, the activation object will create a new instance of the other object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFActivate::ShutdownObject']/*"/>
|
|
<msdn-id>ms695228</msdn-id>
|
|
<unmanaged>HRESULT IMFActivate::ShutdownObject()</unmanaged>
|
|
<unmanaged-short>IMFActivate::ShutdownObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Activate.DetachObject">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Detaches the created object from the activation object.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>Not implemented.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The activation object releases all of its internal references to the created object. If you call <strong>ActivateObject</strong> again, the activation object will create a new instance of the other object.</p><p>The <strong>DetachObject</strong> method does not shut down the created object. If the <strong>DetachObject</strong> method succeeds, the client must shut down the created object. This rule applies only to objects that have a shutdown method or that support the <strong><see cref="T:SharpDX.MediaFoundation.Shutdownable"/></strong> interface. See the remarks for <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong>.</p><p>Implementation of this method is optional. If the activation object does not support this method, the method returns E_NOTIMPL.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFActivate::DetachObject']/*"/>
|
|
<msdn-id>aa367342</msdn-id>
|
|
<unmanaged>HRESULT IMFActivate::DetachObject()</unmanaged>
|
|
<unmanaged-short>IMFActivate::DetachObject</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ASFContentInfo">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Provides methods to work with the header section of files conforming to the Advanced Systems Format (ASF) specification. </p><p>The ASF ContentInfo Object exposes this interface. To create the get a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ASFContentInfo"/></strong> interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFContentInfo(SharpDX.MediaFoundation.ASFContentInfo@)"/></strong>. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFContentInfo']/*"/>
|
|
<msdn-id>ms701620</msdn-id>
|
|
<unmanaged>IMFASFContentInfo</unmanaged>
|
|
<unmanaged-short>IMFASFContentInfo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFContentInfo.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ASFContentInfo"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFContentInfo.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ASFContentInfo">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ASFContentInfo"/>. (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.MediaFoundation.ASFContentInfo.GetHeaderSize(SharpDX.MediaFoundation.MediaBuffer,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Retrieves the size of the header section of an Advanced Systems Format (ASF) file. </p>
|
|
</summary>
|
|
<param name="iStartOfContentRef"><dd> <p>The <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface of a buffer object containing the beginning of ASF content. The size of the valid data in the buffer must be at least MFASF_MIN_HEADER_BYTES in bytes.</p> </dd></param>
|
|
<param name="cbHeaderSize"><dd> <p>Receives the size, in bytes, of the header section of the content. The value includes the size of the ASF Header Object plus the size of the header section of the Data Object. Therefore, the resulting value is the offset to the start of the data packets in the ASF Data Object.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ASF_INVALIDDATA</strong></dt> </dl> </td><td> <p> The buffer does not contain valid ASF data. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BUFFERTOOSMALL</strong></dt> </dl> </td><td> <p> The buffer does not contain enough valid data. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The header of an ASF file or stream can be passed to the <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.ParseHeader(SharpDX.MediaFoundation.MediaBuffer,System.Int64)"/></strong> method to populate the ContentInfo object with the header information.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFContentInfo::GetHeaderSize']/*"/>
|
|
<msdn-id>ms703043</msdn-id>
|
|
<unmanaged>HRESULT IMFASFContentInfo::GetHeaderSize([In] IMFMediaBuffer* pIStartOfContent,[In] unsigned longlong* cbHeaderSize)</unmanaged>
|
|
<unmanaged-short>IMFASFContentInfo::GetHeaderSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFContentInfo.ParseHeader(SharpDX.MediaFoundation.MediaBuffer,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Parses the information in an ASF header and uses that information to set values in the ContentInfo object. You can pass the entire header in a single buffer or send it in several pieces.</p>
|
|
</summary>
|
|
<param name="iHeaderBufferRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface of a buffer object containing some or all of the header. The buffer must contain at least 30 bytes, which is the size of the Header Object, not including the objects contained in the Header Object (that is, everything up to and including the Reserved2 field in the Header Object).</p> </dd></param>
|
|
<param name="cbOffsetWithinHeader"><dd> <p>Offset, in bytes, of the first byte in the buffer relative to the beginning of the header.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The header is completely parsed and validated.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ASF_INVALIDDATA</strong></dt> </dl> </td><td> <p>The input buffer does not contain valid ASF data.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BUFFERTOOSMALL</strong></dt> </dl> </td><td> <p>The input buffer is to small.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_S_ASF_PARSEINPROGRESS</strong></dt> </dl> </td><td> <p>The method succeeded, but the header passed was incomplete. This is the successful return code for all calls but the last one when passing the header in pieces.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If you pass the header in pieces, the ContentInfo object will keep references to the buffer objects until the entire header is parsed. Therefore, do not write over the buffers passed into this method.</p><p>The start of the Header object has the following layout in memory:</p><table> <tr><th>Field Name</th><th>Size in bytes</th></tr> <tr><td>Object ID</td><td>16</td></tr> <tr><td>Object Size</td><td>8</td></tr> <tr><td>Number of Header Objects</td><td>4</td></tr> <tr><td>Reserved1</td><td>1</td></tr> <tr><td>Reserved2</td><td>1</td></tr> </table><p>?</p><p>The first call to <strong>ParseHeader</strong> reads everything up to and including Rerserved2, so it requires a minimum of 30 bytes. (Note that the <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.GetHeaderSize(SharpDX.MediaFoundation.MediaBuffer,System.Int64)"/></strong> method reads only the Object ID and Object Size fields, so that method requires a minimum of 24 bytes.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFContentInfo::ParseHeader']/*"/>
|
|
<msdn-id>ms694306</msdn-id>
|
|
<unmanaged>HRESULT IMFASFContentInfo::ParseHeader([In] IMFMediaBuffer* pIHeaderBuffer,[In] unsigned longlong cbOffsetWithinHeader)</unmanaged>
|
|
<unmanaged-short>IMFASFContentInfo::ParseHeader</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFContentInfo.GenerateHeader(SharpDX.MediaFoundation.MediaBuffer,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Encodes the data in the <strong>MFASFContentInfo</strong> object into a binary Advanced Systems Format (ASF) header.</p>
|
|
</summary>
|
|
<param name="iHeaderRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface of the buffer object that will receive the encoded header. Set to <strong><c>null</c></strong> to retrieve the size of the header. </p> </dd></param>
|
|
<param name="cbHeaderRef"><dd> <p> Size of the encoded ASF header in bytes. If <em>pIHeader</em> is <strong><c>null</c></strong>, this value is set to the buffer size required to hold the encoded header. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p> The ASF Header Objects do not exist for the media that the ContentInfo object holds reference to. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ASF_INVALIDDATA</strong></dt> </dl> </td><td> <p> The ASF Header Object size exceeds 10 MB. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BUFFERTOOSMALL</strong></dt> </dl> </td><td> <p> The buffer passed in <em>pIHeader</em> is not large enough to hold the ASF Header Object information. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The size received in the <em>pcbHeader</em> parameter includes the padding size. The content information shrinks or expands the padding data depending on the size of the ASF Header Objects.</p><p>During this call, the stream properties are set based on the encoding properties of the profile. These properties are available through the <strong><see cref="T:SharpDX.MediaFoundation.Metadata"/></strong> interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFContentInfo::GenerateHeader']/*"/>
|
|
<msdn-id>ms701575</msdn-id>
|
|
<unmanaged>HRESULT IMFASFContentInfo::GenerateHeader([In] IMFMediaBuffer* pIHeader,[In] unsigned int* pcbHeader)</unmanaged>
|
|
<unmanaged-short>IMFASFContentInfo::GenerateHeader</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFContentInfo.GetProfile(SharpDX.MediaFoundation.ASFProfile@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves an Advanced Systems Format (ASF) profile that describes the ASF content.</p>
|
|
</summary>
|
|
<param name="iProfileOut"><dd> <p>Receives an <strong><see cref="T:SharpDX.MediaFoundation.ASFProfile"/></strong> interface reference. The caller must release the interface. If the object does not have an ASF profile, this parameter receives the value <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The profile is set by calling either <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.SetProfile(SharpDX.MediaFoundation.ASFProfile)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.ParseHeader(SharpDX.MediaFoundation.MediaBuffer,System.Int64)"/></strong>.</p><p>The ASF profile object returned by this method does not include any of the <strong>MF_PD_ASF_xxx</strong> attributes (see Presentation Descriptor Attributes). To get these attributes, do the following:</p><ol> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.GeneratePresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor@)"/></strong> to get the ASF presentation descriptor. You can query the presentation descriptor for the <strong>MF_PD_ASF_xxx</strong> attributes.</p> </li> <li> <p>(Optional.) Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFProfileFromPresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor,SharpDX.MediaFoundation.ASFProfile@)"/></strong> to convert the presentation descriptor into an ASF profile. The profile object created by this function contains the <strong>MF_PD_ASF_xxx</strong> attributes.</p> </li> </ol><p>An ASF profile is a template for file encoding, and is intended mainly for creating ASF content. If you are reading an existing ASF file, it is recommended that you use the presentation descriptor to get information about the file. One exception is that the profile contains the mutual exclusion and stream prioritization objects, which are not exposed directly from the presentation descriptor.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFContentInfo::GetProfile']/*"/>
|
|
<msdn-id>ms698931</msdn-id>
|
|
<unmanaged>HRESULT IMFASFContentInfo::GetProfile([In] IMFASFProfile** ppIProfile)</unmanaged>
|
|
<unmanaged-short>IMFASFContentInfo::GetProfile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFContentInfo.SetProfile(SharpDX.MediaFoundation.ASFProfile)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Uses profile data from a profile object to configure settings in the ContentInfo object.</p>
|
|
</summary>
|
|
<param name="iProfileRef"><dd> <p>The <strong><see cref="T:SharpDX.MediaFoundation.ASFProfile"/></strong> interface of the profile object.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If there is already information in the ContentInfo object when this method is called, it is replaced by the information from the profile object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFContentInfo::SetProfile']/*"/>
|
|
<msdn-id>ms699846</msdn-id>
|
|
<unmanaged>HRESULT IMFASFContentInfo::SetProfile([In] IMFASFProfile* pIProfile)</unmanaged>
|
|
<unmanaged-short>IMFASFContentInfo::SetProfile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFContentInfo.GeneratePresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates a presentation descriptor for ASF content.</p>
|
|
</summary>
|
|
<param name="iPresentationDescriptorOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFContentInfo::GeneratePresentationDescriptor']/*"/>
|
|
<msdn-id>ms704860</msdn-id>
|
|
<unmanaged>HRESULT IMFASFContentInfo::GeneratePresentationDescriptor([In] IMFPresentationDescriptor** ppIPresentationDescriptor)</unmanaged>
|
|
<unmanaged-short>IMFASFContentInfo::GeneratePresentationDescriptor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFContentInfo.GetEncodingConfigurationPropertyStore(System.Int16,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves a property store that can be used to set encoding properties.</p>
|
|
</summary>
|
|
<param name="wStreamNumber"><dd> <p>Stream number to configure. Set to zero to configure file-level encoding properties.</p> </dd></param>
|
|
<param name="iStoreOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFContentInfo::GetEncodingConfigurationPropertyStore']/*"/>
|
|
<msdn-id>ms704750</msdn-id>
|
|
<unmanaged>HRESULT IMFASFContentInfo::GetEncodingConfigurationPropertyStore([In] unsigned short wStreamNumber,[In] IPropertyStore** ppIStore)</unmanaged>
|
|
<unmanaged-short>IMFASFContentInfo::GetEncodingConfigurationPropertyStore</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ASFContentInfo.Profile">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves an Advanced Systems Format (ASF) profile that describes the ASF content.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The profile is set by calling either <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.SetProfile(SharpDX.MediaFoundation.ASFProfile)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.ParseHeader(SharpDX.MediaFoundation.MediaBuffer,System.Int64)"/></strong>.</p><p>The ASF profile object returned by this method does not include any of the <strong>MF_PD_ASF_xxx</strong> attributes (see Presentation Descriptor Attributes). To get these attributes, do the following:</p><ol> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.GeneratePresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor@)"/></strong> to get the ASF presentation descriptor. You can query the presentation descriptor for the <strong>MF_PD_ASF_xxx</strong> attributes.</p> </li> <li> <p>(Optional.) Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFProfileFromPresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor,SharpDX.MediaFoundation.ASFProfile@)"/></strong> to convert the presentation descriptor into an ASF profile. The profile object created by this function contains the <strong>MF_PD_ASF_xxx</strong> attributes.</p> </li> </ol><p>An ASF profile is a template for file encoding, and is intended mainly for creating ASF content. If you are reading an existing ASF file, it is recommended that you use the presentation descriptor to get information about the file. One exception is that the profile contains the mutual exclusion and stream prioritization objects, which are not exposed directly from the presentation descriptor.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFContentInfo::GetProfile']/*"/>
|
|
<msdn-id>ms698931</msdn-id>
|
|
<unmanaged>GetProfile</unmanaged>
|
|
<unmanaged-short>GetProfile</unmanaged-short>
|
|
<unmanaged>HRESULT IMFASFContentInfo::GetProfile([In] IMFASFProfile** ppIProfile)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ASFIndexer">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Provides methods to work with indexes in Systems Format (ASF) files. The ASF indexer object exposes this interface. To create the ASF indexer, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFIndexer(SharpDX.MediaFoundation.ASFIndexer@)"/></strong>.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>You can use the indexer object to read an existing ASF index or write a new index. The index object has two mutually exclusive modes: read mode and write mode. To set the mode, call <strong>SetFlags</strong>. </p><p>Use the following methods to configure the indexer object (both modes):</p><ul> <li> <strong>Initialize</strong> </li> <li> <strong>SetFlags</strong> </li> <li> <strong>SetIndexByteStreams</strong> </li> </ul><p>Use the following methods to read an existing index:</p><ul> <li> <strong>GetFlags</strong> </li> <li> <strong>GetIndexByteStreamCount</strong> </li> <li> <strong>GetIndexPosition</strong> </li> <li> <strong>GetIndexStatus</strong> </li> <li> <strong>GetSeekPositionForValue</strong> </li> </ul><p>Use the following methods to write an index:</p><ul> <li> <strong>CommitIndex</strong> </li> <li> <strong>GenerateIndexEntries</strong> </li> <li> <strong>GetCompletedIndex</strong> </li> <li> <strong>GetIndexWriteSpace</strong> </li> <li> <strong>SetIndexStatus</strong> </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer']/*"/>
|
|
<msdn-id>ms700820</msdn-id>
|
|
<unmanaged>IMFASFIndexer</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ASFIndexer"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ASFIndexer">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ASFIndexer"/>. (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.MediaFoundation.ASFIndexer.SetFlags(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets indexer options.</p>
|
|
</summary>
|
|
<param name="dwFlags"><dd> <p>Bitwise OR of zero or more flags from the <strong>MFASF_INDEXER_FLAGS</strong> enumeration specifying the indexer options to use.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The indexer object was initialized before setting flags for it. For more information, see Remarks.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p><strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.SetFlags(System.Int32)"/></strong> must be called before <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.Initialize(SharpDX.MediaFoundation.ASFContentInfo)"/></strong>. Attempting to call <strong>SetFlags</strong> after <strong>Initialize</strong> will return MF_E_INVALIDREQUEST as a result.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::SetFlags']/*"/>
|
|
<msdn-id>ms699840</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::SetFlags([In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::SetFlags</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.GetFlags(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the flags that indicate the selected indexer options.</p>
|
|
</summary>
|
|
<param name="dwFlagsRef"><dd> <p>Receives a bitwise OR of zero or more flags from the <strong>MFASF_INDEXER_FLAGS</strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>pdwFlags</em> is <strong><c>null</c></strong>.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You must call this method before initializing the indexer object with <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.Initialize(SharpDX.MediaFoundation.ASFContentInfo)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::GetFlags']/*"/>
|
|
<msdn-id>ms701578</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::GetFlags([In] unsigned int* pdwFlags)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::GetFlags</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.Initialize(SharpDX.MediaFoundation.ASFContentInfo)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Initializes the indexer object. This method reads information in a ContentInfo object about the configuration of the content and the properties of the existing index, if present. Use this method before using the indexer for either writing or reading an index. You must make this call before using any of the other methods of the <strong><see cref="T:SharpDX.MediaFoundation.ASFIndexer"/></strong> interface.</p>
|
|
</summary>
|
|
<param name="iContentInfoRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ASF_INVALIDDATA</strong></dt> </dl> </td><td> <p>Invalid ASF data.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNEXPECTED</strong></dt> </dl> </td><td> <p>Unexpected error.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The indexer needs to examine the data in the ContentInfo object to properly write or read the index for the content. The indexer will not make changes to the content information and will not hold any references to the <strong><see cref="T:SharpDX.MediaFoundation.ASFContentInfo"/></strong> interface.</p><p>In the ASF header, the maximum data-packet size must equal the minimum data-packet size. Otherwise, the method returns <strong>MF_E_UNEXPECTED</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::Initialize']/*"/>
|
|
<msdn-id>ms703030</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::Initialize([In] IMFASFContentInfo* pIContentInfo)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::Initialize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.GetIndexPosition(SharpDX.MediaFoundation.ASFContentInfo,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the offset of the index object from the start of the content.</p>
|
|
</summary>
|
|
<param name="iContentInfoRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.ASFContentInfo"/></strong> interface of the ContentInfo object that describes the content.</p> </dd></param>
|
|
<param name="cbIndexOffsetRef"><dd> <p>Receives the offset of the index relative to the beginning of the content described by the ContentInfo object. This is the position relative to the beginning of the ASF file.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>pIContentInfo</em> is <strong><c>null</c></strong> or <em>pcbIndexOffset</em> is <strong><c>null</c></strong></p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The index continues from the offset retrieved by this method to the end of the file.</p><p>You must call <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.Initialize(SharpDX.MediaFoundation.ASFContentInfo)"/></strong> to set up the indexer before calling this method.</p><p>If the index is retrieved by using more than one call to <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.GetCompletedIndex(SharpDX.MediaFoundation.MediaBuffer,System.Int64)"/></strong>, the position of individual index portions is equal to the index offset plus the offset of the portion within the index.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::GetIndexPosition']/*"/>
|
|
<msdn-id>ms699858</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::GetIndexPosition([In] IMFASFContentInfo* pIContentInfo,[In] unsigned longlong* pcbIndexOffset)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::GetIndexPosition</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.SetIndexByteStreams(SharpDX.MediaFoundation.ByteStream@,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Adds byte streams to be indexed.</p>
|
|
</summary>
|
|
<param name="iByteStreamsOut"><dd> <p>An array of <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface references. To get the byte stream, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFIndexerByteStream(SharpDX.MediaFoundation.ByteStream,System.Int64,SharpDX.MediaFoundation.ByteStream@)"/></strong>.</p> </dd></param>
|
|
<param name="cByteStreams"><dd> <p>The number of references in the <em>ppIByteStreams</em> array.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ALREADY_INITIALIZED</strong></dt> </dl> </td><td> <p>The indexer object has already been initialized and it has packets which have been indexed.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For a reading scenario, only one byte stream should be used by the indexer object. For an index generating scenario, it depends how many index objects are needed to be generated. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::SetIndexByteStreams']/*"/>
|
|
<msdn-id>ms704843</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::SetIndexByteStreams([In] IMFByteStream** ppIByteStreams,[In] unsigned int cByteStreams)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::SetIndexByteStreams</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.GetIndexByteStreamCount(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of byte streams that are in use by the indexer object.</p>
|
|
</summary>
|
|
<param name="cByteStreamsRef"><dd> <p>Receives the number of byte streams that are in use by the indexer object.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>pcByteStreams</em> is <strong><c>null</c></strong>.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::GetIndexByteStreamCount']/*"/>
|
|
<msdn-id>ms701789</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::GetIndexByteStreamCount([In] unsigned int* pcByteStreams)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::GetIndexByteStreamCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.GetIndexStatus(SharpDX.MediaFoundation.AsfIndexIdentifier@,System.Boolean,System.Byte,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the index settings for a specified stream and index type.</p>
|
|
</summary>
|
|
<param name="indexIdentifierRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.AsfIndexIdentifier"/></strong> structure that contains the stream number and index type for which to get the status.</p> </dd></param>
|
|
<param name="fIsIndexedRef"><dd> <p>A variable that retrieves a Boolean value specifying whether the index described by <em>pIndexIdentifier</em> has been created.</p> </dd></param>
|
|
<param name="bIndexDescriptorRef"><dd> <p>A buffer that receives the index descriptor. The index descriptor consists of an <strong><see cref="T:SharpDX.MediaFoundation.AsfIndexDescriptor"/></strong> structure, optionally followed by index-specific data.</p> </dd></param>
|
|
<param name="cbIndexDescriptorRef"><dd> <p>On input, specifies the size, in bytes, of the buffer that <em>pbIndexDescriptor</em> points to. The value can be zero if <em>pbIndexDescriptor</em> is <strong><c>null</c></strong>. On output, receives the size of the index descriptor, in bytes.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BUFFERTOOSMALL</strong></dt> </dl> </td><td> <p>The buffer size specified in <em>pcbIndexDescriptor</em> is too small.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To read an existing ASF index, call <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.SetIndexByteStreams(SharpDX.MediaFoundation.ByteStream@,System.Int32)"/></strong> before calling this method.</p><p>If an index exists for the stream and the value passed into <em>pcbIndexDescriptor</em> is smaller than the required size of the <em>pbIndexDescriptor</em> buffer, the method returns MF_E_BUFFERTOOSMALL. The required buffer size is returned in the <em>pcbIndexDescriptor</em> parameter.</p><p>If there is no index for the specified stream, the method returns <strong><see cref="F:SharpDX.Result.False"/></strong> in the <em>pfIsIndexed</em> parameter.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::GetIndexStatus']/*"/>
|
|
<msdn-id>ms704012</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::GetIndexStatus([In] ASF_INDEX_IDENTIFIER* pIndexIdentifier,[In] BOOL* pfIsIndexed,[In] unsigned char* pbIndexDescriptor,[In] unsigned int* pcbIndexDescriptor)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::GetIndexStatus</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.SetIndexStatus(System.Byte,System.Int32,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Configures the index for a stream.</p>
|
|
</summary>
|
|
<param name="bIndexDescriptorRef"><dd> <p>The index descriptor to set. The index descriptor is an <strong><see cref="T:SharpDX.MediaFoundation.AsfIndexDescriptor"/></strong> structure, optionally followed by index-specific data.</p> </dd></param>
|
|
<param name="cbIndexDescriptor"><dd> <p>The size, in bytes, of the index descriptor.</p> </dd></param>
|
|
<param name="fGenerateIndex"><dd> <p>A Boolean value. Set to <strong>TRUE</strong> to have the indexer create an index of the type specified for the stream specified in the index descriptor.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>At attempt was made to change the index status in a seek-only scenario. For more information, see Remarks.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You must make all calls to <strong>SetIndexStatus</strong> before making any calls to <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.GenerateIndexEntries(SharpDX.MediaFoundation.Sample)"/></strong>.</p><p>The indexer object is configured to create temporal indexes for each stream by default. Call this method only if you want to override the default settings.</p><p>You cannot use this method in an index reading scenario. You can only use this method when writing indexes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::SetIndexStatus']/*"/>
|
|
<msdn-id>ms702981</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::SetIndexStatus([In] unsigned char* pbIndexDescriptor,[In] unsigned int cbIndexDescriptor,[In] BOOL fGenerateIndex)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::SetIndexStatus</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.GetSeekPositionForValue(SharpDX.Win32.Variant,SharpDX.MediaFoundation.AsfIndexIdentifier@,System.Int64,System.Int64,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Given a desired seek time, gets the offset from which the client should start reading data. </p>
|
|
</summary>
|
|
<param name="varValueRef"><dd> <p> The value of the index entry for which to get the position. The format of this value varies depending on the type of index, which is specified in the index identifier. For time-based indexing, the variant type is <strong>VT_I8</strong> and the value is the desired seek time, in 100-nanosecond units. </p> </dd></param>
|
|
<param name="indexIdentifierRef"><dd> <p> Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.AsfIndexIdentifier"/></strong> structure that identifies the stream number and index type. </p> </dd></param>
|
|
<param name="cbOffsetWithinDataRef"><dd> <p> Receives the offset within the data segment of the ASF Data Object. The offset is in bytes, and is relative to the start of packet 0. The offset gives the starting location from which the client should begin reading from the stream. This location might not correspond exactly to the requested seek time. </p> <p> For reverse playback, if no key frame exists after the desired seek position, this parameter receives the value <strong>MFASFINDEXER_READ_FOR_REVERSEPLAYBACK_OUTOFDATASEGMENT</strong>. In that case, the seek position should be 1 byte pass the end of the data segment. </p> </dd></param>
|
|
<param name="hnsApproxTimeRef"><dd> <p> Receives the approximate time stamp of the data that is located at the offset returned in the <em>pcbOffsetWithinData</em> parameter. The accuracy of this value is equal to the indexing interval of the ASF index, typically about 1 second. </p> <ul> <li> If the index type specified in <em>pIndexIdentifier</em> is <strong>GUID_NULL</strong> (time indexing), this parameter can be <strong><c>null</c></strong>. </li> <li> For all other index types, this parameter must be <strong><c>null</c></strong>. </li> </ul> <p> If the approximate time stamp cannot be determined, this parameter receives the value <strong>MFASFINDEXER_APPROX_SEEK_TIME_UNKNOWN</strong>. </p> </dd></param>
|
|
<param name="dwPayloadNumberOfStreamWithinPacketRef"><dd> <p> Receives the payload number of the payload that contains the information for the specified stream. Packets can contain multiple payloads, each containing data for a different stream. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ASF_OUTOFRANGE</strong></dt> </dl> </td><td> <p> The requested seek time is out of range. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_INDEX</strong></dt> </dl> </td><td> <p> No index exists of the specified type for the specified stream. </p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::GetSeekPositionForValue']/*"/>
|
|
<msdn-id>ms703125</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::GetSeekPositionForValue([In] const PROPVARIANT* pvarValue,[In] ASF_INDEX_IDENTIFIER* pIndexIdentifier,[In] unsigned longlong* pcbOffsetWithinData,[In] longlong* phnsApproxTime,[In] unsigned int* pdwPayloadNumberOfStreamWithinPacket)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::GetSeekPositionForValue</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.GenerateIndexEntries(SharpDX.MediaFoundation.Sample)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Accepts an ASF packet for the file and creates index entries for them.</p>
|
|
</summary>
|
|
<param name="iASFPacketSampleRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of a media sample that contains the ASF packet. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The argument passed in is <strong><c>null</c></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The indexer is not initialized.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The ASF indexer creates indexes for a file internally. You can get the completed index for all data packets sent to the indexer by committing the index with <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.CommitIndex(SharpDX.MediaFoundation.ASFContentInfo)"/></strong> and then calling <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.GetCompletedIndex(SharpDX.MediaFoundation.MediaBuffer,System.Int64)"/></strong> to write the index entries into a media buffer. To determine the size of the index so you can allocate a buffer large enough to hold the index, call <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.GetIndexWriteSpace(System.Int64)"/></strong>.</p><p> When this method creates index entries, they are immediately available for use by <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.GetSeekPositionForValue(SharpDX.Win32.Variant,SharpDX.MediaFoundation.AsfIndexIdentifier@,System.Int64,System.Int64,System.Int32)"/></strong>. </p><p> The media sample specified in <em>pIASFPacketSample</em> must hold a buffer that contains a single ASF packet. Get the sample from the ASF multiplexer by calling the <strong><see cref="M:SharpDX.MediaFoundation.ASFMultiplexer.GetNextPacket(System.Int32,SharpDX.MediaFoundation.Sample@)"/></strong> method. </p><p>You cannot use this method while reading an index, only when writing an index.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::GenerateIndexEntries']/*"/>
|
|
<msdn-id>ms705660</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::GenerateIndexEntries([In] IMFSample* pIASFPacketSample)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::GenerateIndexEntries</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.CommitIndex(SharpDX.MediaFoundation.ASFContentInfo)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Adds information about a new index to the ContentInfo object associated with ASF content. You must call this method before copying the index to the content so that the index will be readable by the indexer later.</p>
|
|
</summary>
|
|
<param name="iContentInfoRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.ASFContentInfo"/></strong> interface of the ContentInfo object that describes the content.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The caller made an invalid request. For more information, see Remarks.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For the index to function properly, you must call this method after all ASF packets in the file have been passed to the indexer by using the <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.GenerateIndexEntries(SharpDX.MediaFoundation.Sample)"/></strong> method. After you call this method, you must retrieve the indexes by calling <strong>GetCompletedIndex</strong> and write them to the appropriate location in the file. Finally, you must generate a new ASF header by calling the <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.GenerateHeader(SharpDX.MediaFoundation.MediaBuffer,System.Int32)"/></strong> method of the ASF ContentInfo object.</p><p> An application must use the <strong>CommitIndex</strong> method only when writing a new index otherwise <strong>CommitIndex</strong> may return MF_E_INVALIDREQUEST as a result. For example, MF_E_INVALIDREQUEST is returned if the application has flags other than <see cref="F:SharpDX.MediaFoundation.AsfIndexerflags.WriteNewIndex"/> set on the indexer object. <strong>CommitIndex</strong> can also return <see cref="F:SharpDX.MediaFoundation.AsfIndexerflags.WriteNewIndex"/> if the index entries have already been committed through an earlier <strong>CommitIndex</strong> call.</p><p>You cannot use this method in an index reading scenario. You can only use this method when writing indexes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::CommitIndex']/*"/>
|
|
<msdn-id>ms696994</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::CommitIndex([In] IMFASFContentInfo* pIContentInfo)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::CommitIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.GetIndexWriteSpace(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the size, in bytes, of the buffer required to store the completed index.</p>
|
|
</summary>
|
|
<param name="cbIndexWriteSpaceRef"><dd> <p>Receives the size of the index, in bytes</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INDEX_NOT_COMMITTED</strong></dt> </dl> </td><td> <p>The index has not been committed. For more information; see Remarks.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Use this method to get the size of the index and then allocate a buffer big enough to hold it. </p><p>The index must be committed with a call to<strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.CommitIndex(SharpDX.MediaFoundation.ASFContentInfo)"/></strong> before calling <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.GetIndexWriteSpace(System.Int64)"/></strong>. If the index is not committed before <strong>GetIndexWriteSpace</strong> is called, then MF_E_INDEX_NOT_COMMITTED will be returned as a result. </p><p>Call <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.GetCompletedIndex(SharpDX.MediaFoundation.MediaBuffer,System.Int64)"/></strong> to write the completed index into a media buffer.</p><p>You cannot use this method in a reading scenario. You can only use this method when writing indexes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::GetIndexWriteSpace']/*"/>
|
|
<msdn-id>ms700198</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::GetIndexWriteSpace([In] unsigned longlong* pcbIndexWriteSpace)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::GetIndexWriteSpace</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFIndexer.GetCompletedIndex(SharpDX.MediaFoundation.MediaBuffer,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the completed index from the ASF indexer object.</p>
|
|
</summary>
|
|
<param name="iIndexBufferRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface of a media buffer that receives the index data.</p> </dd></param>
|
|
<param name="cbOffsetWithinIndex"><dd> <p>The offset of the data to be retrieved, in bytes from the start of the index data. Set to 0 for the first call. If subsequent calls are needed (the buffer is not large enough to hold the entire index), set to the byte following the last one retrieved.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INDEX_NOT_COMMITTED</strong></dt> </dl> </td><td> <p>The index was not committed before attempting to get the completed index. For more information, see Remarks.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method uses as much of the buffer as possible, and updates the length of the buffer appropriately.</p><p>If <em>pIIndexBuffer</em> is large enough to contain the entire buffer, <em>cbOffsetWithinIndex</em> should be 0, and the call needs to be made only once. Otherwise, there should be no gaps between successive buffers.</p><p>The user must write this data to the content at <em>cbOffsetFromIndexStart</em> bytes after the end of the ASF data object. You can call <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.GetIndexPosition(SharpDX.MediaFoundation.ASFContentInfo,System.Int64)"/></strong> to determine the start position of the ASF index.</p><p>This call will not succeed unless <strong><see cref="M:SharpDX.MediaFoundation.ASFIndexer.CommitIndex(SharpDX.MediaFoundation.ASFContentInfo)"/></strong> has been called. After calling <strong>GetCompletedIndex</strong>, the caller must call <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.GenerateHeader(SharpDX.MediaFoundation.MediaBuffer,System.Int32)"/></strong> and overwrite the existing ASF header with the new header; otherwise, the ASF header will not match the content, and the file is not guaranteed to play correctly.</p><p>You cannot use this method in an index reading scenario. You can only use this method when writing indexes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFIndexer::GetCompletedIndex']/*"/>
|
|
<msdn-id>ms702077</msdn-id>
|
|
<unmanaged>HRESULT IMFASFIndexer::GetCompletedIndex([In] IMFMediaBuffer* pIIndexBuffer,[In] unsigned longlong cbOffsetWithinIndex)</unmanaged>
|
|
<unmanaged-short>IMFASFIndexer::GetCompletedIndex</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ASFMultiplexer">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Provides methods to create Advanced Systems Format (ASF) data packets. The methods of this interface process input samples into the packets that make up an ASF data section. The ASF multiplexer exposes this interface. To create the ASF multiplexer, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFMultiplexer(SharpDX.MediaFoundation.ASFMultiplexer@)"/></strong>.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer']/*"/>
|
|
<msdn-id>ms703009</msdn-id>
|
|
<unmanaged>IMFASFMultiplexer</unmanaged>
|
|
<unmanaged-short>IMFASFMultiplexer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMultiplexer.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ASFMultiplexer"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMultiplexer.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ASFMultiplexer">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ASFMultiplexer"/>. (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.MediaFoundation.ASFMultiplexer.Initialize(SharpDX.MediaFoundation.ASFContentInfo)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Initializes the multiplexer with the data from an ASF ContentInfo object.</p>
|
|
</summary>
|
|
<param name="iContentInfoRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.ASFContentInfo"/></strong> interface of the <strong>MFASFContentInfo</strong> object that contains the header information of the new ASF file. The multiplexer will generate data packets for this file.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This call must be made once at the beginning of encoding, with <em>pIContentInfo</em> pointing to the ASF ContentInfo object that describes the content to be encoded. This enables the ASF multiplexer to see, among other things, which streams will be present in the encoding session. This call typically does not affect the data in the ASF ContentInfo object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer::Initialize']/*"/>
|
|
<msdn-id>ms697469</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMultiplexer::Initialize([In] IMFASFContentInfo* pIContentInfo)</unmanaged>
|
|
<unmanaged-short>IMFASFMultiplexer::Initialize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMultiplexer.SetFlags(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets multiplexer options.</p>
|
|
</summary>
|
|
<param name="dwFlags"><dd> <p>Bitwise <strong>OR</strong> of zero or more members of the <strong><see cref="T:SharpDX.MediaFoundation.AsfMultiplexerflags"/></strong> enumeration. These flags specify which multiplexer options to use. For more information, see "Multiplexer Initialization and Leaky Bucket Settings" in Creating the Multiplexer Object.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer::SetFlags']/*"/>
|
|
<msdn-id>ms703986</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMultiplexer::SetFlags([In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IMFASFMultiplexer::SetFlags</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMultiplexer.GetFlags(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves flags indicating the configured multiplexer options.</p>
|
|
</summary>
|
|
<param name="dwFlagsRef"><dd> <p>Receives a bitwise <strong>OR</strong> of zero or more values from the <strong><see cref="T:SharpDX.MediaFoundation.AsfMultiplexerflags"/></strong> enumeration. To set these flags, call <strong><see cref="M:SharpDX.MediaFoundation.ASFMultiplexer.SetFlags(System.Int32)"/></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer::GetFlags']/*"/>
|
|
<msdn-id>ms702166</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMultiplexer::GetFlags([In] unsigned int* pdwFlags)</unmanaged>
|
|
<unmanaged-short>IMFASFMultiplexer::GetFlags</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMultiplexer.ProcessSample(System.Int16,SharpDX.MediaFoundation.Sample,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Delivers input samples to the multiplexer. </p>
|
|
</summary>
|
|
<param name="wStreamNumber"><dd> <p> The stream number of the stream to which the sample belongs. </p> </dd></param>
|
|
<param name="iSampleRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of the input sample. The input sample contains the media data to be converted to ASF data packets. When possible, the time stamp of this sample should be accurate. </p> </dd></param>
|
|
<param name="hnsTimestampAdjust"><dd> <p> The adjustment to apply to the time stamp of the sample. This parameter is used if the caller wants to shift the sample time on <em>pISample</em>. This value should be positive if the time stamp should be pushed ahead and negative if the time stamp should be pushed back. This time stamp is added to sample time on <em>pISample</em>, and the resulting time is used by the multiplexer instead of the original sample time. If no adjustment is needed, set this value to 0. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOTACCEPTING</strong></dt> </dl> </td><td> <p> There are too many packets waiting to be retrieved from the multiplexer. Call <strong><see cref="M:SharpDX.MediaFoundation.ASFMultiplexer.GetNextPacket(System.Int32,SharpDX.MediaFoundation.Sample@)"/></strong> to get the packets.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BANDWIDTH_OVERRUN</strong></dt> </dl> </td><td> <p> The sample that was processed violates the bandwidth limitations specified for the stream in the ASF ContentInfo object. When this error is generated, the sample is dropped. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> The value passed in <em>wStreamNumber</em> is invalid. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_LATE_SAMPLE</strong></dt> </dl> </td><td> <p> The presentation time of the input media sample is earlier than the send time. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> The application passes samples to <strong>ProcessSample</strong>, and the ASF multiplexer queues them internally until they are ready to be placed into ASF packets. Call <strong><see cref="M:SharpDX.MediaFoundation.ASFMultiplexer.GetNextPacket(System.Int32,SharpDX.MediaFoundation.Sample@)"/></strong> to get the ASF data packet. </p><p>After each call to <strong>ProcessSample</strong>, call <strong>GetNextPacket</strong> in a loop to get all of the available data packets. For a code example, see Generating New ASF Data Packets.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer::ProcessSample']/*"/>
|
|
<msdn-id>ms696206</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMultiplexer::ProcessSample([In] unsigned short wStreamNumber,[In] IMFSample* pISample,[In] longlong hnsTimestampAdjust)</unmanaged>
|
|
<unmanaged-short>IMFASFMultiplexer::ProcessSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMultiplexer.GetNextPacket(System.Int32,SharpDX.MediaFoundation.Sample@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the next output ASF packet from the multiplexer.</p>
|
|
</summary>
|
|
<param name="dwStatusFlagsRef"><dd> <p> Receives zero or more status flags. If more than one packet is waiting, the method sets the <strong><see cref="F:SharpDX.MediaFoundation.AsfStatusflags.Incomplete"/></strong> flag. </p> </dd></param>
|
|
<param name="iPacketOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of the first output sample of the data packet. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> The client needs to call this method, ideally after every call to <strong><see cref="M:SharpDX.MediaFoundation.ASFMultiplexer.ProcessSample(System.Int16,SharpDX.MediaFoundation.Sample,System.Int64)"/></strong>, to get the output ASF packets. Call this method in a loop as long as the <strong><see cref="F:SharpDX.MediaFoundation.AsfStatusflags.Incomplete"/></strong> flag is received. </p><p>If no packets are ready, the method returns <strong><see cref="F:SharpDX.Result.Ok"/></strong> but does not return a sample in <em>ppIPacket</em>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer::GetNextPacket']/*"/>
|
|
<msdn-id>ms696243</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMultiplexer::GetNextPacket([In] unsigned int* pdwStatusFlags,[In] IMFSample** ppIPacket)</unmanaged>
|
|
<unmanaged-short>IMFASFMultiplexer::GetNextPacket</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMultiplexer.Flush">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Signals the multiplexer to process all queued output media samples. Call this method after passing the last sample to the multiplexer.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You must call <strong>Flush</strong> after the last sample has been passed into the ASF multiplexer and before you call <strong><see cref="M:SharpDX.MediaFoundation.ASFMultiplexer.End(SharpDX.MediaFoundation.ASFContentInfo)"/></strong>. This causes all output media samples in progress to be completed. After calling <strong>Flush</strong>, call <strong><see cref="M:SharpDX.MediaFoundation.ASFMultiplexer.GetNextPacket(System.Int32,SharpDX.MediaFoundation.Sample@)"/></strong> in a loop until all the pending media samples have been packetized.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer::Flush']/*"/>
|
|
<msdn-id>ms696991</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMultiplexer::Flush()</unmanaged>
|
|
<unmanaged-short>IMFASFMultiplexer::Flush</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMultiplexer.End(SharpDX.MediaFoundation.ASFContentInfo)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Collects data from the multiplexer and updates the ASF ContentInfo object to include that information in the ASF Header Object.</p>
|
|
</summary>
|
|
<param name="iContentInfoRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.ASFContentInfo"/></strong> interface of the ContentInfo object. This must be the same object that was used to initialize the multiplexer. The ContentInfo object represents the ASF Header Object of the file for which the multiplexer generated data packets.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_FLUSH_NEEDED</strong></dt> </dl> </td><td> <p>There are pending output media samples waiting in the multiplexer. Call <strong><see cref="M:SharpDX.MediaFoundation.ASFMultiplexer.Flush"/></strong> to force the media samples to be packetized.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For non-live encoding scenarios (such as encoding to a file), the user should call <strong>End</strong> to update the specified ContentInfo object, adding data that the multiplexer has collected during the packet generation process. The user should then call <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.GenerateHeader(SharpDX.MediaFoundation.MediaBuffer,System.Int32)"/></strong> and write the output header at the beginning of the ASF file (overwriting the header obtained at the beginning of the encoding session). For more information, see Writing an ASF Header Object for a New File.</p><p>During live encoding, it is usually not possible to rewrite the header, so this call is not required for live encoding. (The header in those cases will simply lack some of the information that was not available until the end of the encoding session.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer::End']/*"/>
|
|
<msdn-id>ms696172</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMultiplexer::End([In] IMFASFContentInfo* pIContentInfo)</unmanaged>
|
|
<unmanaged-short>IMFASFMultiplexer::End</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMultiplexer.GetStatistics(System.Int16,SharpDX.MediaFoundation.AsfMuxStatistics)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves multiplexer statistics.</p>
|
|
</summary>
|
|
<param name="wStreamNumber"><dd> <p>The stream number for which to obtain statistics.</p> </dd></param>
|
|
<param name="muxStatsRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.AsfMuxStatistics"/></strong> structure that receives the statistics.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer::GetStatistics']/*"/>
|
|
<msdn-id>ms697232</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMultiplexer::GetStatistics([In] unsigned short wStreamNumber,[In] ASF_MUX_STATISTICS* pMuxStats)</unmanaged>
|
|
<unmanaged-short>IMFASFMultiplexer::GetStatistics</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMultiplexer.SetSyncTolerance(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the maximum time by which samples from various streams can be out of synchronization. The multiplexer will not accept a sample with a time stamp that is out of synchronization with the latest samples from any other stream by an amount that exceeds the synchronization tolerance.</p>
|
|
</summary>
|
|
<param name="msSyncTolerance"><dd> <p>Synchronization tolerance in milliseconds.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The synchronization tolerance is the maximum difference in presentation times at any given point between samples of different streams that the ASF multiplexer can accommodate. That is, if the synchronization tolerance is 3 seconds, no stream can be more than 3 seconds behind any other stream in the time stamps passed to the multiplexer. The multiplexer determines a default synchronization tolerance to use, but this method overrides it (usually to increase it). More tolerance means the potential for greater latency in the multiplexer. If the time stamps are synchronized among the streams, actual latency will be much lower than <em>msSyncTolerance</em>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer::SetSyncTolerance']/*"/>
|
|
<msdn-id>ms697206</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMultiplexer::SetSyncTolerance([In] unsigned int msSyncTolerance)</unmanaged>
|
|
<unmanaged-short>IMFASFMultiplexer::SetSyncTolerance</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ASFMultiplexer.SyncTolerance">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the maximum time by which samples from various streams can be out of synchronization. The multiplexer will not accept a sample with a time stamp that is out of synchronization with the latest samples from any other stream by an amount that exceeds the synchronization tolerance.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The synchronization tolerance is the maximum difference in presentation times at any given point between samples of different streams that the ASF multiplexer can accommodate. That is, if the synchronization tolerance is 3 seconds, no stream can be more than 3 seconds behind any other stream in the time stamps passed to the multiplexer. The multiplexer determines a default synchronization tolerance to use, but this method overrides it (usually to increase it). More tolerance means the potential for greater latency in the multiplexer. If the time stamps are synchronized among the streams, actual latency will be much lower than <em>msSyncTolerance</em>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMultiplexer::SetSyncTolerance']/*"/>
|
|
<msdn-id>ms697206</msdn-id>
|
|
<unmanaged>SetSyncTolerance</unmanaged>
|
|
<unmanaged-short>SetSyncTolerance</unmanaged-short>
|
|
<unmanaged>HRESULT IMFASFMultiplexer::SetSyncTolerance([In] unsigned int msSyncTolerance)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ASFMutualExclusion">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Adds a stream number to a record in the Advanced Systems Format mutual exclusion object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Each record includes one or more streams. Every stream in a record is mutually exclusive of all streams in every other record.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMutualExclusion']/*"/>
|
|
<msdn-id>ms703794</msdn-id>
|
|
<unmanaged>IMFASFMutualExclusion</unmanaged>
|
|
<unmanaged-short>IMFASFMutualExclusion</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMutualExclusion.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ASFMutualExclusion"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMutualExclusion.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ASFMutualExclusion">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ASFMutualExclusion"/>. (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.MediaFoundation.ASFMutualExclusion.GetTypeInfo(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the type of mutual exclusion represented by the Advanced Systems Format (ASF) mutual exclusion object.</p>
|
|
</summary>
|
|
<param name="guidTypeRef"><dd> <p>A variable that receives the type identifier. For a list of predefined mutual exclusion type constants, see ASF Mutual Exclusion Type GUIDs.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Sometimes, content must be made mutually exclusive in more than one way. For example, a video file might contain audio streams of several bit rates for each of several languages. To handle this type of complex mutual exclusion, you must configure more than one ASF mutual exclusion object. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.ASFMutualExclusion.AddRecord(System.Int32)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMutualExclusion::GetType']/*"/>
|
|
<msdn-id>ms703095</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMutualExclusion::GetType([In] GUID* pguidType)</unmanaged>
|
|
<unmanaged-short>IMFASFMutualExclusion::GetType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMutualExclusion.SetType(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the type of mutual exclusion that is represented by the Advanced Systems Format (ASF) mutual exclusion object.</p>
|
|
</summary>
|
|
<param name="guidType"><dd> <p>The type of mutual exclusion that is represented by the ASF mutual exclusion object. For a list of predefined mutual exclusion type constants, see ASF Mutual Exclusion Type GUIDs.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Sometimes, content must be made mutually exclusive in more than one way. For example, a video file might contain audio streams in several bit rates for each of several languages. To handle this type of complex mutual exclusion, you must configure more than one ASF mutual exclusion object. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.ASFMutualExclusion.AddRecord(System.Int32)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMutualExclusion::SetType']/*"/>
|
|
<msdn-id>ms697261</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMutualExclusion::SetType([In] const GUID& guidType)</unmanaged>
|
|
<unmanaged-short>IMFASFMutualExclusion::SetType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMutualExclusion.GetRecordCount(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of records in the Advanced Systems Format mutual exclusion object.</p>
|
|
</summary>
|
|
<param name="dwRecordCountRef"><dd> <p>Receives the count of records.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Each record includes one or more streams. Every stream in a record is mutually exclusive of streams in every other record.</p><p>Use this method in conjunction with <strong><see cref="M:SharpDX.MediaFoundation.ASFMutualExclusion.GetStreamsForRecord(System.Int32,System.Int16,System.Int32)"/></strong> to retrieve the streams that are included in each record.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMutualExclusion::GetRecordCount']/*"/>
|
|
<msdn-id>ms700201</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMutualExclusion::GetRecordCount([In] unsigned int* pdwRecordCount)</unmanaged>
|
|
<unmanaged-short>IMFASFMutualExclusion::GetRecordCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMutualExclusion.GetStreamsForRecord(System.Int32,System.Int16,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the stream numbers contained in a record in the Advanced Systems Format mutual exclusion object.</p>
|
|
</summary>
|
|
<param name="dwRecordNumber"><dd> <p>The number of the record for which to retrieve the stream numbers.</p> </dd></param>
|
|
<param name="wStreamNumArrayRef"><dd> <p>An array that receives the stream numbers. Set to <strong><c>null</c></strong> to get the number of elements required, which is indicated by the value of <em>pcStreams</em> on return. If this parameter is not <strong><c>null</c></strong>, the method will copy as many stream numbers to the array as there are elements indicated by the value of <em>pcStreams</em>.</p> </dd></param>
|
|
<param name="cStreamsRef"><dd> <p>On input, the number of elements in the array referenced by <em>pwStreamNumArray</em>. On output, the method sets this value to the count of stream numbers in the record. You can call <strong>GetStreamsForRecord</strong> with <em>pwStreamNumArray</em> set to <strong><c>null</c></strong> to retrieve the number of elements required to hold all of the stream numbers.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMutualExclusion::GetStreamsForRecord']/*"/>
|
|
<msdn-id>ms703200</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMutualExclusion::GetStreamsForRecord([In] unsigned int dwRecordNumber,[In] unsigned short* pwStreamNumArray,[In] unsigned int* pcStreams)</unmanaged>
|
|
<unmanaged-short>IMFASFMutualExclusion::GetStreamsForRecord</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMutualExclusion.AddStreamForRecord(System.Int32,System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Adds a stream number to a record in the Advanced Systems Format mutual exclusion object.</p>
|
|
</summary>
|
|
<param name="dwRecordNumber"><dd> <p>The record number to which the stream is added. A record number is set by the <strong><see cref="M:SharpDX.MediaFoundation.ASFMutualExclusion.AddRecord(System.Int32)"/></strong> method.</p> </dd></param>
|
|
<param name="wStreamNumber"><dd> <p>The stream number to add to the record.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The specified stream number is already associated with the record.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Each record includes one or more streams. Every stream in a record is mutually exclusive of all streams in every other record.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMutualExclusion::AddStreamForRecord']/*"/>
|
|
<msdn-id>ms703794</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMutualExclusion::AddStreamForRecord([In] unsigned int dwRecordNumber,[In] unsigned short wStreamNumber)</unmanaged>
|
|
<unmanaged-short>IMFASFMutualExclusion::AddStreamForRecord</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMutualExclusion.RemoveStreamFromRecord(System.Int32,System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Removes a stream number from a record in the Advanced Systems Format mutual exclusion object.</p>
|
|
</summary>
|
|
<param name="dwRecordNumber"><dd> <p>The record number from which to remove the stream number.</p> </dd></param>
|
|
<param name="wStreamNumber"><dd> <p>The stream number to remove from the record.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The stream number is not listed for the specified record.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMutualExclusion::RemoveStreamFromRecord']/*"/>
|
|
<msdn-id>ms703971</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMutualExclusion::RemoveStreamFromRecord([In] unsigned int dwRecordNumber,[In] unsigned short wStreamNumber)</unmanaged>
|
|
<unmanaged-short>IMFASFMutualExclusion::RemoveStreamFromRecord</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMutualExclusion.RemoveRecord(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Removes a record from the Advanced Systems Format (ASF) mutual exclusion object.</p>
|
|
</summary>
|
|
<param name="dwRecordNumber"><dd> <p>The index of the record to remove.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When a record is removed, the ASF mutual exclusion object indexes the remaining records so that they are sequential starting with zero. You should enumerate the records to ensure that you have the correct index for each record. If the record removed is the one with the highest index, removing it has no effect on the other indexes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMutualExclusion::RemoveRecord']/*"/>
|
|
<msdn-id>ms704808</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMutualExclusion::RemoveRecord([In] unsigned int dwRecordNumber)</unmanaged>
|
|
<unmanaged-short>IMFASFMutualExclusion::RemoveRecord</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMutualExclusion.AddRecord(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Adds a record to the mutual exclusion object. A record specifies streams that are mutually exclusive with the streams in all other records.</p>
|
|
</summary>
|
|
<param name="dwRecordNumberRef"><dd> <p>Receives the index assigned to the new record. Record indexes are zero-based and sequential.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>A record can include one or more stream numbers. All of the streams in a record are mutually exclusive with all the streams in all other records in the ASF mutual exclusion object.</p><p>You can use records to create complex mutual exclusion scenarios by using multiple ASF mutual exclusion objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMutualExclusion::AddRecord']/*"/>
|
|
<msdn-id>ms705615</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMutualExclusion::AddRecord([In] unsigned int* pdwRecordNumber)</unmanaged>
|
|
<unmanaged-short>IMFASFMutualExclusion::AddRecord</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFMutualExclusion.Clone(SharpDX.MediaFoundation.ASFMutualExclusion@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates a copy of the Advanced Systems Format mutual exclusion object.</p>
|
|
</summary>
|
|
<param name="iMutexOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ASFMutualExclusion"/></strong> interface of the new object. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The cloned object is a new object, completely independent of the object from which it was cloned.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFMutualExclusion::Clone']/*"/>
|
|
<msdn-id>ms696217</msdn-id>
|
|
<unmanaged>HRESULT IMFASFMutualExclusion::Clone([In] IMFASFMutualExclusion** ppIMutex)</unmanaged>
|
|
<unmanaged-short>IMFASFMutualExclusion::Clone</unmanaged-short>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "P:SharpDX.MediaFoundation.ASFMutualExclusion.Type" -->
|
|
<member name="T:SharpDX.MediaFoundation.ASFProfile">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Manages an Advanced Systems Format (ASF) profile. A profile is a collection of information that describes the configuration of streams that will be included in an ASF file. Information about the relationships between streams is also included in the profile.</p><p>An <strong><see cref="T:SharpDX.MediaFoundation.ASFProfile"/></strong> interface exists for every ASF profile object. To create an ASF profile object, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFProfile(SharpDX.MediaFoundation.ASFProfile@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFProfileFromPresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor,SharpDX.MediaFoundation.ASFProfile@)"/></strong>.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile']/*"/>
|
|
<msdn-id>ms705658</msdn-id>
|
|
<unmanaged>IMFASFProfile</unmanaged>
|
|
<unmanaged-short>IMFASFProfile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ASFProfile"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ASFProfile">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ASFProfile"/>. (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.MediaFoundation.ASFProfile.GetStreamCount(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of streams in the profile.</p>
|
|
</summary>
|
|
<param name="cStreamsRef"><dd> <p>Receives the number of streams in the profile.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::GetStreamCount']/*"/>
|
|
<msdn-id>ms703024</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::GetStreamCount([In] unsigned int* pcStreams)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::GetStreamCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.GetStream(System.Int32,System.Int16,SharpDX.MediaFoundation.ASFStreamConfig@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves a stream from the profile by stream index, and/or retrieves the stream number for a stream index.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The index of the stream to retrieve. Stream indexes are sequential and zero-based. You can get the number of streams that are in the profile by calling the <strong><see cref="M:SharpDX.MediaFoundation.ASFProfile.GetStreamCount(System.Int32)"/></strong> method.</p> </dd></param>
|
|
<param name="wStreamNumberRef"><dd> <p>Receives the stream number of the requested stream. Stream numbers are one-based and are not necessarily sequential. This parameter can be set to <strong><c>null</c></strong> if the stream number is not required.</p> </dd></param>
|
|
<param name="iStreamOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ASFStreamConfig"/></strong> interface of the ASF stream configuration object. The caller must release the interface. This parameter can be <strong><c>null</c></strong> if you want to retrieve the stream number without accessing the stream configuration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method does not create a copy of the stream configuration object. The reference that is retrieved points to the object within the profile object. You must not make any changes to the stream configuration object using this reference, because doing so can affect the profile object in unexpected ways.</p><p>To change the configuration of the stream configuration object in the profile, you must first clone the stream configuration object by calling <strong><see cref="M:SharpDX.MediaFoundation.ASFStreamConfig.Clone(SharpDX.MediaFoundation.ASFStreamConfig@)"/></strong>. Make whatever changes are required to the clone of the object and then add the updated object by calling the <strong><see cref="M:SharpDX.MediaFoundation.ASFProfile.SetStream(SharpDX.MediaFoundation.ASFStreamConfig)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::GetStream']/*"/>
|
|
<msdn-id>ms700799</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::GetStream([In] unsigned int dwStreamIndex,[In] unsigned short* pwStreamNumber,[In] IMFASFStreamConfig** ppIStream)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::GetStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.GetStreamByNumber(System.Int16,SharpDX.MediaFoundation.ASFStreamConfig@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves an Advanced Systems Format (ASF) stream configuration object for a stream in the profile. This method references the stream by stream number instead of stream index.</p>
|
|
</summary>
|
|
<param name="wStreamNumber"><dd> <p>The stream number for which to obtain the interface reference.</p> </dd></param>
|
|
<param name="iStreamOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ASFStreamConfig"/></strong> interface of the ASF stream configuration object. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method does not create a copy of the stream configuration object. The reference that is retrieved points to the object within the profile object. You must not make any changes to the stream configuration object using this reference, because doing so can affect the profile object in unexpected ways.</p><p>To change the configuration of the stream configuration object in the profile, you must first clone the stream configuration object by calling <strong><see cref="M:SharpDX.MediaFoundation.ASFStreamConfig.Clone(SharpDX.MediaFoundation.ASFStreamConfig@)"/></strong>. Make whatever changes are required to the clone of the object and then add the updated object by calling the <strong><see cref="M:SharpDX.MediaFoundation.ASFProfile.SetStream(SharpDX.MediaFoundation.ASFStreamConfig)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::GetStreamByNumber']/*"/>
|
|
<msdn-id>ms694981</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::GetStreamByNumber([In] unsigned short wStreamNumber,[In] IMFASFStreamConfig** ppIStream)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::GetStreamByNumber</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.SetStream(SharpDX.MediaFoundation.ASFStreamConfig)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Adds a stream to the profile or reconfigures an existing stream.</p>
|
|
</summary>
|
|
<param name="iStreamRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.ASFStreamConfig"/></strong> interface of a configured ASF stream configuration object.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the stream number in the ASF stream configuration object is already included in the profile, the information in the new object replaces the old one. If the profile does not contain a stream for the stream number, the ASF stream configuration object is added as a new stream.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::SetStream']/*"/>
|
|
<msdn-id>ms703051</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::SetStream([In] IMFASFStreamConfig* pIStream)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::SetStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.RemoveStream(System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Removes a stream from the Advanced Systems Format (ASF) profile object.</p>
|
|
</summary>
|
|
<param name="wStreamNumber"><dd> <p>Stream number of the stream to remove.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>After a stream is removed, the ASF profile object reassigns stream indexes so that the index values are sequential starting from zero. Any previously stored stream index numbers are no longer valid after deleting a stream.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::RemoveStream']/*"/>
|
|
<msdn-id>ms704569</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::RemoveStream([In] unsigned short wStreamNumber)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::RemoveStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.CreateStream(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.ASFStreamConfig@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates an Advanced Systems Format (ASF) stream configuration object.</p>
|
|
</summary>
|
|
<param name="iMediaTypeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of a configured media type.</p> </dd></param>
|
|
<param name="iStreamOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ASFStreamConfig"/></strong> interface of the new ASF stream configuration object. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>ppIStream</em> is <strong><c>null</c></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>E_OUTOFMEMORY</strong></dt> </dl> </td><td> <p>stream configuration object could not be created due to insufficient memory.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The ASF stream configuration object created by this method is not included in the profile. To include the stream, you must first configure the stream configuration and then call <strong><see cref="M:SharpDX.MediaFoundation.ASFProfile.SetStream(SharpDX.MediaFoundation.ASFStreamConfig)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::CreateStream']/*"/>
|
|
<msdn-id>ms696264</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::CreateStream([In] IMFMediaType* pIMediaType,[In] IMFASFStreamConfig** ppIStream)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::CreateStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.GetMutualExclusionCount(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of Advanced Systems Format (ASF) mutual exclusion objects that are associated with the profile.</p>
|
|
</summary>
|
|
<param name="cMutexsRef"><dd> <p>Receives the number of mutual exclusion objects.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Multiple mutual exclusion objects may be required for streams that are mutually exclusive in more than one way. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.ASFMutualExclusion.AddRecord(System.Int32)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::GetMutualExclusionCount']/*"/>
|
|
<msdn-id>ms697361</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::GetMutualExclusionCount([In] unsigned int* pcMutexs)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::GetMutualExclusionCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.GetMutualExclusion(System.Int32,SharpDX.MediaFoundation.ASFMutualExclusion@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves an Advanced Systems Format (ASF) mutual exclusion object from the profile.</p>
|
|
</summary>
|
|
<param name="dwMutexIndex"><dd> <p>Index of the mutual exclusion object in the profile.</p> </dd></param>
|
|
<param name="iMutexOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ASFMutualExclusion"/></strong> interface of the ASF mutual exclusion object. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method does not create a copy of the mutual exclusion object. The returned reference refers to the mutual exclusion contained in the profile object. You must not make any changes to the mutual exclusion object using this reference, because doing so can affect the profile object in unexpected ways.</p><p>To change the configuration of the mutual exclusion object in the profile, you must first clone the mutual exclusion object by calling <strong><see cref="M:SharpDX.MediaFoundation.ASFMutualExclusion.Clone(SharpDX.MediaFoundation.ASFMutualExclusion@)"/></strong>. Make whatever changes are required to the clone of the object, remove the old mutual exclusion object from the profile by calling the <strong><see cref="M:SharpDX.MediaFoundation.ASFProfile.RemoveMutualExclusion(System.Int32)"/></strong> method, and then add the updated object by calling the <strong><see cref="M:SharpDX.MediaFoundation.ASFProfile.AddMutualExclusion(SharpDX.MediaFoundation.ASFMutualExclusion)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::GetMutualExclusion']/*"/>
|
|
<msdn-id>ms701598</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::GetMutualExclusion([In] unsigned int dwMutexIndex,[In] IMFASFMutualExclusion** ppIMutex)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::GetMutualExclusion</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.AddMutualExclusion(SharpDX.MediaFoundation.ASFMutualExclusion)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Adds a configured Advanced Systems Format (ASF) mutual exclusion object to the profile.</p>
|
|
</summary>
|
|
<param name="iMutexRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.ASFMutualExclusion"/></strong> interface of a configured ASF mutual exclusion object.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You can create a mutual exclusion object by calling the <strong><see cref="M:SharpDX.MediaFoundation.ASFProfile.CreateMutualExclusion(SharpDX.MediaFoundation.ASFMutualExclusion@)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::AddMutualExclusion']/*"/>
|
|
<msdn-id>ms703965</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::AddMutualExclusion([In] IMFASFMutualExclusion* pIMutex)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::AddMutualExclusion</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.RemoveMutualExclusion(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Removes an Advanced Systems Format (ASF) mutual exclusion object from the profile.</p>
|
|
</summary>
|
|
<param name="dwMutexIndex"><dd> <p>The index of the mutual exclusion object to remove from the profile.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When a mutual exclusion object is removed from the profile, the ASF profile object reassigns the mutual exclusion indexes so that they are sequential starting with zero. Any previously stored indexes are no longer valid after calling this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::RemoveMutualExclusion']/*"/>
|
|
<msdn-id>ms704007</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::RemoveMutualExclusion([In] unsigned int dwMutexIndex)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::RemoveMutualExclusion</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.CreateMutualExclusion(SharpDX.MediaFoundation.ASFMutualExclusion@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates a new Advanced Systems Format (ASF) mutual exclusion object. Mutual exclusion objects can be added to a profile by calling the <strong>AddMutualExclusion</strong> method.</p>
|
|
</summary>
|
|
<param name="iMutexOut">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The ASF mutual exclusion object created by this method is not associated with the profile. Call <strong><see cref="M:SharpDX.MediaFoundation.ASFProfile.AddMutualExclusion(SharpDX.MediaFoundation.ASFMutualExclusion)"/></strong> after configuring the object to make this association.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::CreateMutualExclusion']/*"/>
|
|
<msdn-id>ms697002</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::CreateMutualExclusion([In] IMFASFMutualExclusion** ppIMutex)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::CreateMutualExclusion</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.GetStreamPrioritization(SharpDX.MediaFoundation.ASFStreamPrioritization@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p><strong>Note</strong>??This method is not supported.</p>
|
|
</summary>
|
|
<param name="iStreamPrioritizationOut"><dd> <p>Reserved.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::GetStreamPrioritization']/*"/>
|
|
<msdn-id>ms695410</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::GetStreamPrioritization([In] IMFASFStreamPrioritization** ppIStreamPrioritization)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::GetStreamPrioritization</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.AddStreamPrioritization(SharpDX.MediaFoundation.ASFStreamPrioritization)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p><strong>Note</strong>??This method is not supported.</p>
|
|
</summary>
|
|
<param name="iStreamPrioritizationRef"><dd> <p>Reserved. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::AddStreamPrioritization']/*"/>
|
|
<msdn-id>ms697516</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::AddStreamPrioritization([In] IMFASFStreamPrioritization* pIStreamPrioritization)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::AddStreamPrioritization</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.RemoveStreamPrioritization">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p><strong>Note</strong>??This method is not supported.</p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::RemoveStreamPrioritization']/*"/>
|
|
<msdn-id>ms701838</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::RemoveStreamPrioritization()</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::RemoveStreamPrioritization</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.CreateStreamPrioritization(SharpDX.MediaFoundation.ASFStreamPrioritization@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p><strong>Note</strong>??This method is not implemented.</p>
|
|
</summary>
|
|
<param name="iStreamPrioritizationOut"><dd> <p>Reserved. </p> </dd></param>
|
|
<returns><p> Returns <strong>E_NOTIMPL</strong>. </p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::CreateStreamPrioritization']/*"/>
|
|
<msdn-id>ms694914</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::CreateStreamPrioritization([In] IMFASFStreamPrioritization** ppIStreamPrioritization)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::CreateStreamPrioritization</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFProfile.Clone(SharpDX.MediaFoundation.ASFProfile@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates a copy of the Advanced Systems Format profile object.</p>
|
|
</summary>
|
|
<param name="iProfileOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ASFProfile"/></strong> interface of the new object. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The cloned object is completely independent of the original.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::Clone']/*"/>
|
|
<msdn-id>ms704773</msdn-id>
|
|
<unmanaged>HRESULT IMFASFProfile::Clone([In] IMFASFProfile** ppIProfile)</unmanaged>
|
|
<unmanaged-short>IMFASFProfile::Clone</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ASFProfile.Stream">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Adds a stream to the profile or reconfigures an existing stream.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the stream number in the ASF stream configuration object is already included in the profile, the information in the new object replaces the old one. If the profile does not contain a stream for the stream number, the ASF stream configuration object is added as a new stream.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::SetStream']/*"/>
|
|
<msdn-id>ms703051</msdn-id>
|
|
<unmanaged>SetStream</unmanaged>
|
|
<unmanaged-short>SetStream</unmanaged-short>
|
|
<unmanaged>HRESULT IMFASFProfile::SetStream([In] IMFASFStreamConfig* pIStream)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ASFProfile.StreamPrioritization">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p><strong>Note</strong>??This method is not supported.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFProfile::GetStreamPrioritization']/*"/>
|
|
<msdn-id>ms695410</msdn-id>
|
|
<unmanaged>GetStreamPrioritization</unmanaged>
|
|
<unmanaged-short>GetStreamPrioritization</unmanaged-short>
|
|
<unmanaged>HRESULT IMFASFProfile::GetStreamPrioritization([In] IMFASFStreamPrioritization** ppIStreamPrioritization)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ASFSplitter">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves a sample from the Advanced Systems Format (ASF) splitter after the data has been parsed.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Before calling this method, call <strong><see cref="M:SharpDX.MediaFoundation.ASFSplitter.ParseData(SharpDX.MediaFoundation.MediaBuffer,System.Int32,System.Int32)"/></strong> to give input data to the splitter. If the input does not contain enough data for a complete sample, the <strong>GetNextSample</strong> method succeeds but returns <strong><c>null</c></strong> in the <em>ppISample</em> parameter.</p><p>The ASF splitter skips samples for unselected streams. To select streams, call <strong><see cref="M:SharpDX.MediaFoundation.ASFSplitter.SelectStreams(System.Int16,System.Int16)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFSplitter']/*"/>
|
|
<msdn-id>ms700167</msdn-id>
|
|
<unmanaged>IMFASFSplitter</unmanaged>
|
|
<unmanaged-short>IMFASFSplitter</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFSplitter.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ASFSplitter"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFSplitter.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ASFSplitter">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ASFSplitter"/>. (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.MediaFoundation.ASFSplitter.Initialize(SharpDX.MediaFoundation.ASFContentInfo)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Resets the Advanced Systems Format (ASF) splitter and configures it to parse data from an ASF data section.</p>
|
|
</summary>
|
|
<param name="iContentInfoRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.ASFContentInfo"/></strong> interface of a ContentInfo object that describes the data to be parsed.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The <em>pIContentInfo</em> parameter is <strong><c>null</c></strong>.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFSplitter::Initialize']/*"/>
|
|
<msdn-id>ms704048</msdn-id>
|
|
<unmanaged>HRESULT IMFASFSplitter::Initialize([In] IMFASFContentInfo* pIContentInfo)</unmanaged>
|
|
<unmanaged-short>IMFASFSplitter::Initialize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFSplitter.SetFlags(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets option flags on the Advanced Systems Format (ASF) splitter.</p>
|
|
</summary>
|
|
<param name="dwFlags"><dd> <p>A bitwise combination of zero or more members of the <strong><see cref="T:SharpDX.MediaFoundation.AsfSplitterflags"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The splitter is not initialized.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The <em>dwFlags</em> parameter does not contain a valid flag.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The <see cref="F:SharpDX.MediaFoundation.AsfSplitterflags.Reverse"/> flag is set, but the content cannot be parsed in reverse.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method can only be called after the splitter is initialized.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFSplitter::SetFlags']/*"/>
|
|
<msdn-id>ms697337</msdn-id>
|
|
<unmanaged>HRESULT IMFASFSplitter::SetFlags([In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IMFASFSplitter::SetFlags</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFSplitter.GetFlags(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the option flags that are set on the ASF splitter.</p>
|
|
</summary>
|
|
<param name="dwFlagsRef"><dd> <p>Receives the option flags. This value is a bitwise <strong>OR</strong> of zero or more members of the <strong><see cref="T:SharpDX.MediaFoundation.AsfSplitterflags"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>pdwFlags</em> is <strong><c>null</c></strong>.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFSplitter::GetFlags']/*"/>
|
|
<msdn-id>ms702288</msdn-id>
|
|
<unmanaged>HRESULT IMFASFSplitter::GetFlags([In] unsigned int* pdwFlags)</unmanaged>
|
|
<unmanaged-short>IMFASFSplitter::GetFlags</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFSplitter.SelectStreams(System.Int16,System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the streams to be parsed by the Advanced Systems Format (ASF) splitter.</p>
|
|
</summary>
|
|
<param name="wStreamNumbersRef"><dd> <p>An array of variables containing the list of stream numbers to select.</p> </dd></param>
|
|
<param name="wNumStreams"><dd> <p>The number of valid elements in the stream number array.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>pwStreamNumbers</em> is <strong><c>null</c></strong> and <em>wNumStreams</em> contains a value greater than zero.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p>Invalid stream number was passed in the array.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Calling this method supersedes any previous stream selections; only the streams specified in the <em>pwStreamNumbers</em> array will be selected.</p><p>By default, no streams are selected by the splitter.</p><p>You can obtain a list of the currently selected streams by calling the <strong><see cref="M:SharpDX.MediaFoundation.ASFSplitter.GetSelectedStreams(System.Int16,System.Int16)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFSplitter::SelectStreams']/*"/>
|
|
<msdn-id>ms701631</msdn-id>
|
|
<unmanaged>HRESULT IMFASFSplitter::SelectStreams([In] unsigned short* pwStreamNumbers,[In] unsigned short wNumStreams)</unmanaged>
|
|
<unmanaged-short>IMFASFSplitter::SelectStreams</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFSplitter.GetSelectedStreams(System.Int16,System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets a list of currently selected streams. </p>
|
|
</summary>
|
|
<param name="wStreamNumbersRef"><dd> <p> The address of an array of <strong>WORDs</strong>. This array receives the stream numbers of the selected streams. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="wNumStreamsRef"><dd> <p>On input, points to a variable that contains the number of elements in the <em>pwStreamNumbers</em> array. Set the variable to zero if <em>pwStreamNumbers</em> is <strong><c>null</c></strong>. </p> <p>On output, receives the number of elements that were copied into <em>pwStreamNumbers</em>. Each element is the identifier of a selected stream.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> Invalid argument. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BUFFERTOOSMALL</strong></dt> </dl> </td><td> <p> The <em>pwStreamNumbers</em> array is smaller than the number of selected streams. See Remarks.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To get the number of selected streams, set <em>pwStreamNumbers</em> to <strong><c>null</c></strong>. The method will return <strong>MF_E_BUFFERTOSMALL</strong> but will also set the value of <code>*pwNumStreams</code> equal to the number of selected streams. Then allocate an array of that size and call the method again, passing the array in the <em>pwStreamNumbers</em> parameter.</p><p>The following code shows these steps:</p><pre><see cref="T:SharpDX.Result"/> DisplaySelectedStreams(<see cref="T:SharpDX.MediaFoundation.ASFSplitter"/> *pSplitter)
|
|
{ WORD count = 0; <see cref="T:SharpDX.Result"/> hr = pSplitter->GetSelectedStreams(<c>null</c>, &count); if (hr == MF_E_BUFFERTOOSMALL) { WORD *pStreamIds = new (std::nothrow) WORD[count]; if (pStreamIds) { hr = pSplitter->GetSelectedStreams(pStreamIds, &count); if (SUCCEEDED(hr)) { for (WORD i = 0; i < count; i++) { printf("Selected stream ID: %d\n", pStreamIds[i]); } } delete [] pStreamIds; } else { hr = E_OUTOFMEMORY; } } return hr;
|
|
}
|
|
</pre><p>Alternatively, you can allocate an array that is equal to the total number of streams and pass that to <em>pwStreamNumbers</em>.</p><p>Before calling this method, initialize <code>*pwNumStreams</code> to the number of elements in <em>pwStreamNumbers</em>. If <em>pwStreamNumbers</em> is <strong><c>null</c></strong>, set <code>*pwNumStreams</code> to zero.</p><p> By default, no streams are selected by the splitter. Select streams by calling the <strong><see cref="M:SharpDX.MediaFoundation.ASFSplitter.SelectStreams(System.Int16,System.Int16)"/></strong> method. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFSplitter::GetSelectedStreams']/*"/>
|
|
<msdn-id>ms705602</msdn-id>
|
|
<unmanaged>HRESULT IMFASFSplitter::GetSelectedStreams([In] unsigned short* pwStreamNumbers,[In] unsigned short* pwNumStreams)</unmanaged>
|
|
<unmanaged-short>IMFASFSplitter::GetSelectedStreams</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFSplitter.ParseData(SharpDX.MediaFoundation.MediaBuffer,System.Int32,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sends packetized Advanced Systems Format (ASF) data to the ASF splitter for processing.</p>
|
|
</summary>
|
|
<param name="iBufferRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface of a buffer object containing data to be parsed.</p> </dd></param>
|
|
<param name="cbBufferOffset"><dd> <p>The offset into the data buffer where the splitter should begin parsing. This value is typically set to 0.</p> </dd></param>
|
|
<param name="cbLength"><dd> <p>The length, in bytes, of the data to parse. This value is measured from the offset specified by <em>cbBufferOffset</em>. Set to 0 to process to the end of the buffer.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The <em>pIBuffer</em> parameter is <strong><c>null</c></strong>.</p> <p>The specified offset value in <em>cbBufferOffset</em> is greater than the length of the buffer.</p> <p>The total value of <em>cbBufferOffset</em> and <em>cbLength</em> is greater than the length of the buffer.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The <strong><see cref="M:SharpDX.MediaFoundation.ASFSplitter.Initialize(SharpDX.MediaFoundation.ASFContentInfo)"/></strong> method was not called or the call failed.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOTACCEPTING</strong></dt> </dl> </td><td> <p>The splitter cannot process more input at this time.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>After using this method to parse data, you must call <strong><see cref="M:SharpDX.MediaFoundation.ASFSplitter.GetNextSample(System.Int32,System.Int16,SharpDX.MediaFoundation.Sample@)"/></strong> to retrieve parsed media samples.</p><p>If your ASF data contains variable-sized packets, you must set the <strong><see cref="F:SharpDX.MediaFoundation.AsfSplitterAttributeKeys.PacketBoundary"/></strong> attribute on the buffers to indicate the sample boundaries, and the buffers cannot span multiple packets.</p><p>If the method returns ME_E_NOTACCEPTING, call <strong>GetNextSample</strong> to get the output samples, or call <strong><see cref="M:SharpDX.MediaFoundation.ASFSplitter.Flush"/></strong> to clear the splitter.</p><p>The splitter might hold a reference count on the input buffer. Therefore, do not write over the valid data in the buffer after calling this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFSplitter::ParseData']/*"/>
|
|
<msdn-id>ms694299</msdn-id>
|
|
<unmanaged>HRESULT IMFASFSplitter::ParseData([In] IMFMediaBuffer* pIBuffer,[In] unsigned int cbBufferOffset,[In] unsigned int cbLength)</unmanaged>
|
|
<unmanaged-short>IMFASFSplitter::ParseData</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFSplitter.GetNextSample(System.Int32,System.Int16,SharpDX.MediaFoundation.Sample@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves a sample from the Advanced Systems Format (ASF) splitter after the data has been parsed.</p>
|
|
</summary>
|
|
<param name="dwStatusFlagsRef"><dd> <p>Receives one of the following values.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.AsfStatusflags.Incomplete"/></strong></dt> </dl> </td><td> <p>More samples are ready to be retrieved. Call <strong>GetNextSample</strong> in a loop until the <em>pdwStatusFlags</em> parameter receives the value zero.</p> </td></tr> <tr><td><dl> <dt><strong>Zero</strong></dt> </dl> </td><td> <p>No additional samples are ready. Call <strong><see cref="M:SharpDX.MediaFoundation.ASFSplitter.ParseData(SharpDX.MediaFoundation.MediaBuffer,System.Int32,System.Int32)"/></strong> to give more input data to the splitter.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="wStreamNumberRef"><dd> <p>If the method returns a sample in the <em>ppISample</em> parameter, this parameter receives the number of the stream to which the sample belongs.</p> </dd></param>
|
|
<param name="iSampleOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of the parsed sample. The caller must release the interface. If no samples are ready, this parameter receives the value <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ASF_INVALIDDATA</strong></dt> </dl> </td><td> <p>The ASF data in the buffer is invalid.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ASF_MISSINGDATA</strong></dt> </dl> </td><td> <p>There is a gap in the ASF data.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Before calling this method, call <strong><see cref="M:SharpDX.MediaFoundation.ASFSplitter.ParseData(SharpDX.MediaFoundation.MediaBuffer,System.Int32,System.Int32)"/></strong> to give input data to the splitter. If the input does not contain enough data for a complete sample, the <strong>GetNextSample</strong> method succeeds but returns <strong><c>null</c></strong> in the <em>ppISample</em> parameter.</p><p>The ASF splitter skips samples for unselected streams. To select streams, call <strong><see cref="M:SharpDX.MediaFoundation.ASFSplitter.SelectStreams(System.Int16,System.Int16)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFSplitter::GetNextSample']/*"/>
|
|
<msdn-id>ms700167</msdn-id>
|
|
<unmanaged>HRESULT IMFASFSplitter::GetNextSample([In] unsigned int* pdwStatusFlags,[In] unsigned short* pwStreamNumber,[In] IMFSample** ppISample)</unmanaged>
|
|
<unmanaged-short>IMFASFSplitter::GetNextSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFSplitter.Flush">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Resets the Advanced Systems Format (ASF) splitter and releases all pending samples.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Any samples waiting to be retrieved when <strong>Flush</strong> is called are lost.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFSplitter::Flush']/*"/>
|
|
<msdn-id>ms703013</msdn-id>
|
|
<unmanaged>HRESULT IMFASFSplitter::Flush()</unmanaged>
|
|
<unmanaged-short>IMFASFSplitter::Flush</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFSplitter.GetLastSendTime(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the send time of the last sample received.</p>
|
|
</summary>
|
|
<param name="dwLastSendTimeRef"><dd> <p>Receives the send time of the last sample received.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>pdwLastSendTime</em> is <strong><c>null</c></strong>.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFSplitter::GetLastSendTime']/*"/>
|
|
<msdn-id>ms697272</msdn-id>
|
|
<unmanaged>HRESULT IMFASFSplitter::GetLastSendTime([In] unsigned int* pdwLastSendTime)</unmanaged>
|
|
<unmanaged-short>IMFASFSplitter::GetLastSendTime</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ASFStreamConfig">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Configures the settings of a stream in an ASF file. The ASF stream configuration object exposes this interface. To obtain a reference to this interface, call the <strong><see cref="M:SharpDX.MediaFoundation.ASFProfile.CreateStream(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.ASFStreamConfig@)"/></strong> method.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig']/*"/>
|
|
<msdn-id>ms699010</msdn-id>
|
|
<unmanaged>IMFASFStreamConfig</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ASFStreamConfig"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ASFStreamConfig">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ASFStreamConfig"/>. (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.MediaFoundation.ASFStreamConfig.GetStreamType(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the major media type of the stream. </p>
|
|
</summary>
|
|
<param name="guidStreamTypeRef"><dd> <p>Receives the major media type for the stream. For a list of possible values, see Major Media Types. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::GetStreamType']/*"/>
|
|
<msdn-id>ms697390</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamConfig::GetStreamType([In] GUID* pguidStreamType)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig::GetStreamType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.GetStreamNumber">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the stream number of the stream.</p>
|
|
</summary>
|
|
<returns><p>The method returns the stream number.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::GetStreamNumber']/*"/>
|
|
<msdn-id>ms703172</msdn-id>
|
|
<unmanaged>unsigned short IMFASFStreamConfig::GetStreamNumber()</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig::GetStreamNumber</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.SetStreamNumber(System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Assigns a stream number to the stream.</p>
|
|
</summary>
|
|
<param name="wStreamNum"><dd> <p>The number to assign to the stream.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Stream numbers start from 1 and do not need to be sequential.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::SetStreamNumber']/*"/>
|
|
<msdn-id>ms697298</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamConfig::SetStreamNumber([In] unsigned short wStreamNum)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig::SetStreamNumber</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.GetMediaType(SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the media type of the stream.</p>
|
|
</summary>
|
|
<param name="iMediaTypeOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type object associated with the stream. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To reduce unnecessary copying, the method returns a reference to the media type that is stored internally by the object. Do not modify the returned media type, as the results are not defined.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::GetMediaType']/*"/>
|
|
<msdn-id>ms697489</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamConfig::GetMediaType([In] IMFMediaType** ppIMediaType)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig::GetMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.SetMediaType(SharpDX.MediaFoundation.MediaType)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the media type for the Advanced Systems Format (ASF) stream configuration object.</p>
|
|
</summary>
|
|
<param name="iMediaTypeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of a configured media type object.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Some validation of the media type is performed by this method. However, a media type can be successfully set, but cause an error when the stream is added to the profile.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::SetMediaType']/*"/>
|
|
<msdn-id>ms697185</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamConfig::SetMediaType([In] IMFMediaType* pIMediaType)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig::SetMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.GetPayloadExtensionCount(System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of payload extensions that are configured for the stream.</p>
|
|
</summary>
|
|
<param name="cPayloadExtensionsRef"><dd> <p>Receives the number of payload extensions.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::GetPayloadExtensionCount']/*"/>
|
|
<msdn-id>ms696251</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamConfig::GetPayloadExtensionCount([In] unsigned short* pcPayloadExtensions)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig::GetPayloadExtensionCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.GetPayloadExtension(System.Int16,System.Guid,System.Int16,System.Byte,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves information about an existing payload extension.</p>
|
|
</summary>
|
|
<param name="wPayloadExtensionNumber"><dd> <p>The payload extension index. Valid indexes range from 0, to one less than the number of extensions obtained by calling <strong><see cref="M:SharpDX.MediaFoundation.ASFStreamConfig.GetPayloadExtensionCount(System.Int16)"/></strong>.</p> </dd></param>
|
|
<param name="guidExtensionSystemIDRef"><dd> <p>Receives a <see cref="T:System.Guid"/> that identifies the payload extension. For a list of predefined payload extensions, see ASF Payload Extension GUIDs. Applications can also define custom payload extensions.</p> </dd></param>
|
|
<param name="cbExtensionDataSizeRef"><dd> <p>Receives the number of bytes added to each sample for the extension.</p> </dd></param>
|
|
<param name="bExtensionSystemInfoRef"><dd> <p>Pointer to a buffer that receives information about this extension system. This information is the same for all samples and is stored in the content header (not in each sample). This parameter can be <strong><c>null</c></strong>. To find the required size of the buffer, set this parameter to <strong><c>null</c></strong>; the size is returned in <em>pcbExtensionSystemInfo</em>.</p> </dd></param>
|
|
<param name="cbExtensionSystemInfoRef"><dd> <p>On input, specifies the size of the buffer pointed to by <em>pbExtensionSystemInfo</em>. On output, receives the required size of the <em>pbExtensionSystemInfo</em> buffer in bytes.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BUFFERTOOSMALL</strong></dt> </dl> </td><td> <p>The buffer specified in <em>pbExtensionSystemInfo</em> is too small.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDINDEX</strong></dt> </dl> </td><td> <p>The <em>wPayloadExtensionNumber</em> parameter is out of range.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::GetPayloadExtension']/*"/>
|
|
<msdn-id>ms697305</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamConfig::GetPayloadExtension([In] unsigned short wPayloadExtensionNumber,[In] GUID* pguidExtensionSystemID,[In] unsigned short* pcbExtensionDataSize,[In] unsigned char* pbExtensionSystemInfo,[In] unsigned int* pcbExtensionSystemInfo)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig::GetPayloadExtension</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.AddPayloadExtension(System.Guid,System.Int16,System.Byte,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Configures a payload extension for the stream.</p>
|
|
</summary>
|
|
<param name="guidExtensionSystemID"><dd> <p>Pointer to a <see cref="T:System.Guid"/> that identifies the payload extension. For a list of predefined payload extensions, see ASF Payload Extension GUIDs. Applications can also define custom payload extensions.</p> </dd></param>
|
|
<param name="cbExtensionDataSize"><dd> <p>Number of bytes added to each sample for the extension.</p> </dd></param>
|
|
<param name="bExtensionSystemInfoRef"><dd> <p>A reference to a buffer that contains information about this extension system. This information is the same for all samples and is stored in the content header (not with each sample). This parameter can be <strong><c>null</c></strong> if <em>cbExtensionSystemInfo</em> is 0.</p> </dd></param>
|
|
<param name="cbExtensionSystemInfo"><dd> <p>Amount of data, in bytes, that describes this extension system. If this value is 0, then <em>pbExtensionSystemInfo</em> can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::AddPayloadExtension']/*"/>
|
|
<msdn-id>ms697229</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamConfig::AddPayloadExtension([In] GUID guidExtensionSystemID,[In] unsigned short cbExtensionDataSize,[In] unsigned char* pbExtensionSystemInfo,[In] unsigned int cbExtensionSystemInfo)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig::AddPayloadExtension</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.RemoveAllPayloadExtensions">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Removes all payload extensions that are configured for the stream.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>None.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::RemoveAllPayloadExtensions']/*"/>
|
|
<msdn-id>ms699009</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamConfig::RemoveAllPayloadExtensions()</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig::RemoveAllPayloadExtensions</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamConfig.Clone(SharpDX.MediaFoundation.ASFStreamConfig@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates a copy of the Advanced Systems Format (ASF) stream configuration object.</p>
|
|
</summary>
|
|
<param name="iStreamConfigOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ASFStreamConfig"/></strong> interface of the new object. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The cloned object is completely independent of the original.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::Clone']/*"/>
|
|
<msdn-id>ms703117</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamConfig::Clone([In] IMFASFStreamConfig** ppIStreamConfig)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamConfig::Clone</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ASFStreamConfig.StreamNumber">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the stream number of the stream.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::GetStreamNumber']/*"/>
|
|
<msdn-id>ms703172</msdn-id>
|
|
<unmanaged>GetStreamNumber</unmanaged>
|
|
<unmanaged-short>GetStreamNumber</unmanaged-short>
|
|
<unmanaged>unsigned short IMFASFStreamConfig::GetStreamNumber()</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ASFStreamConfig.MediaType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the media type of the stream.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To reduce unnecessary copying, the method returns a reference to the media type that is stored internally by the object. Do not modify the returned media type, as the results are not defined.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamConfig::GetMediaType']/*"/>
|
|
<msdn-id>ms697489</msdn-id>
|
|
<unmanaged>GetMediaType</unmanaged>
|
|
<unmanaged-short>GetMediaType</unmanaged-short>
|
|
<unmanaged>HRESULT IMFASFStreamConfig::GetMediaType([In] IMFMediaType** ppIMediaType)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ASFStreamPrioritization">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Note</strong>??This interface is not implemented in this version of Media Foundation.</p><p>Retrieves the stream number of a stream in the stream priority list.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamPrioritization']/*"/>
|
|
<msdn-id>ms697005</msdn-id>
|
|
<unmanaged>IMFASFStreamPrioritization</unmanaged>
|
|
<unmanaged-short>IMFASFStreamPrioritization</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamPrioritization.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ASFStreamPrioritization"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamPrioritization.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ASFStreamPrioritization">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ASFStreamPrioritization"/>. (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.MediaFoundation.ASFStreamPrioritization.GetStreamCount(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Note</strong>??This interface is not implemented in this version of Media Foundation.</p><p>Retrieves the number of entries in the stream priority list.</p>
|
|
</summary>
|
|
<param name="dwStreamCountRef"><dd> <p>Receives the number of streams in the stream priority list.</p> </dd></param>
|
|
<returns><p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamPrioritization::GetStreamCount']/*"/>
|
|
<msdn-id>bb970449</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamPrioritization::GetStreamCount([In] unsigned int* pdwStreamCount)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamPrioritization::GetStreamCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamPrioritization.GetStream(System.Int32,System.Int16,System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Note</strong>??This interface is not implemented in this version of Media Foundation.</p><p>Retrieves the stream number of a stream in the stream priority list.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>Zero-based index of the entry to retrieve from the stream priority list. To get the number of entries in the priority list, call <strong><see cref="M:SharpDX.MediaFoundation.ASFStreamPrioritization.GetStreamCount(System.Int32)"/></strong>.</p> </dd></param>
|
|
<param name="wStreamNumberRef"><dd> <p>Receives the stream number of the stream priority entry.</p> </dd></param>
|
|
<param name="wStreamFlagsRef"><dd> <p>Receives a Boolean value. If <strong>TRUE</strong>, the stream is mandatory.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><strong><c>null</c></strong> reference argument or the <em>dwStreamIndex</em> parameter is out of range.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamPrioritization::GetStream']/*"/>
|
|
<msdn-id>ms697005</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamPrioritization::GetStream([In] unsigned int dwStreamIndex,[In] unsigned short* pwStreamNumber,[In] unsigned short* pwStreamFlags)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamPrioritization::GetStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamPrioritization.AddStream(System.Int16,System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Note</strong>??This interface is not implemented in this version of Media Foundation.</p><p>Adds a stream to the stream priority list.</p>
|
|
</summary>
|
|
<param name="wStreamNumber"><dd> <p>Stream number of the stream to add.</p> </dd></param>
|
|
<param name="wStreamFlags"><dd> <p>If <strong>TRUE</strong>, the stream is mandatory.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Invalid stream number.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The stream priority list is built by appending entries to the list with each call to <strong>AddStream</strong>. The list is evaluated in descending order of importance. The most important stream should be added first, and the least important should be added last.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamPrioritization::AddStream']/*"/>
|
|
<msdn-id>ms696987</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamPrioritization::AddStream([In] unsigned short wStreamNumber,[In] unsigned short wStreamFlags)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamPrioritization::AddStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamPrioritization.RemoveStream(System.Int32)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwStreamIndex">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='IMFASFStreamPrioritization::RemoveStream']/*"/>
|
|
<unmanaged>HRESULT IMFASFStreamPrioritization::RemoveStream([In] unsigned int dwStreamIndex)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamPrioritization::RemoveStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamPrioritization.Clone(SharpDX.MediaFoundation.ASFStreamPrioritization@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Note</strong>??This interface is not implemented in this version of Media Foundation.</p><p>Creates a copy of the ASF stream prioritization object.</p>
|
|
</summary>
|
|
<param name="iStreamPrioritizationOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.ASFStreamPrioritization"/></strong> interface of the new object. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The new object is completely independent of the original.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamPrioritization::Clone']/*"/>
|
|
<msdn-id>ms704679</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamPrioritization::Clone([In] IMFASFStreamPrioritization** ppIStreamPrioritization)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamPrioritization::Clone</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ASFStreamSelector">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Selects streams in an Advanced Systems Format (ASF) file, based on the mutual exclusion information in the ASF header. The ASF stream selector object exposes this interface. To create the ASF stream selector, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFStreamSelector(SharpDX.MediaFoundation.ASFProfile,SharpDX.MediaFoundation.ASFStreamSelector@)"/></strong>.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector']/*"/>
|
|
<msdn-id>ms703857</msdn-id>
|
|
<unmanaged>IMFASFStreamSelector</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ASFStreamSelector"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ASFStreamSelector">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ASFStreamSelector"/>. (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.MediaFoundation.ASFStreamSelector.GetStreamCount(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of streams that are in the Advanced Systems Format (ASF) content.</p>
|
|
</summary>
|
|
<param name="cStreamsRef"><dd> <p>Receives the number of streams in the content.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::GetStreamCount']/*"/>
|
|
<msdn-id>ms704621</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::GetStreamCount([In] unsigned int* pcStreams)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::GetStreamCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.GetOutputCount(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of outputs for the Advanced Systems Format (ASF) content.</p>
|
|
</summary>
|
|
<param name="cOutputsRef"><dd> <p>Receives the number of outputs.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Outputs are streams in the ASF data section that will be parsed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::GetOutputCount']/*"/>
|
|
<msdn-id>ms694076</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::GetOutputCount([In] unsigned int* pcOutputs)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::GetOutputCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.GetOutputStreamCount(System.Int32,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of streams associated with an output.</p>
|
|
</summary>
|
|
<param name="dwOutputNum"><dd> <p>The output number for which to retrieve the stream count.</p> </dd></param>
|
|
<param name="cStreamsRef"><dd> <p>Receives the number of streams associated with the output.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Invalid output number.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>An output is a stream in an ASF data section that will be parsed. If mutual exclusion is used, mutually exclusive streams share the same output.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::GetOutputStreamCount']/*"/>
|
|
<msdn-id>ms700815</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::GetOutputStreamCount([In] unsigned int dwOutputNum,[In] unsigned int* pcStreams)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::GetOutputStreamCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.GetOutputStreamNumbers(System.Int32,System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the stream numbers for all of the streams that are associated with an output.</p>
|
|
</summary>
|
|
<param name="dwOutputNum"><dd> <p>The output number for which to retrieve stream numbers.</p> </dd></param>
|
|
<param name="rgwStreamNumbers"><dd> <p>Address of an array that receives the stream numbers associated with the output. The caller allocates the array. The array size must be at least as large as the value returned by the <strong><see cref="M:SharpDX.MediaFoundation.ASFStreamSelector.GetOutputStreamCount(System.Int32,System.Int32)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Invalid output number.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>An output is a stream in an ASF data section that will be parsed. If mutual exclusion is used, mutually exclusive streams share the same output.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::GetOutputStreamNumbers']/*"/>
|
|
<msdn-id>ms697025</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::GetOutputStreamNumbers([In] unsigned int dwOutputNum,[In] unsigned short* rgwStreamNumbers)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::GetOutputStreamNumbers</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.GetOutputFromStream(System.Int16,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the output number associated with a stream.</p>
|
|
</summary>
|
|
<param name="wStreamNum"><dd> <p>The stream number for which to retrieve an output number.</p> </dd></param>
|
|
<param name="dwOutputRef"><dd> <p>Receives the output number.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Invalid stream number.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Outputs are streams in the ASF data section that will be parsed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::GetOutputFromStream']/*"/>
|
|
<msdn-id>ms701979</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::GetOutputFromStream([In] unsigned short wStreamNum,[In] unsigned int* pdwOutput)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::GetOutputFromStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.GetOutputOverride(System.Int32,SharpDX.MediaFoundation.AsfSelectionStatus)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the manual output override selection that is set for a stream.</p>
|
|
</summary>
|
|
<param name="dwOutputNum"><dd> <p>Stream number for which to retrieve the output override selection.</p> </dd></param>
|
|
<param name="selectionRef"><dd> <p>Receives the output override selection. The value is a member of the <strong><see cref="T:SharpDX.MediaFoundation.AsfSelectionStatus"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::GetOutputOverride']/*"/>
|
|
<msdn-id>ms697510</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::GetOutputOverride([In] unsigned int dwOutputNum,[In] ASF_SELECTION_STATUS* pSelection)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::GetOutputOverride</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.SetOutputOverride(System.Int32,SharpDX.MediaFoundation.AsfSelectionStatus)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the selection status of an output, overriding other selection criteria.</p>
|
|
</summary>
|
|
<param name="dwOutputNum"><dd> <p>Output number for which to set selection.</p> </dd></param>
|
|
<param name="selection"><dd> <p>Member of the <strong><see cref="T:SharpDX.MediaFoundation.AsfSelectionStatus"/></strong> enumeration specifying the level of selection for the output.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::SetOutputOverride']/*"/>
|
|
<msdn-id>ms703122</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::SetOutputOverride([In] unsigned int dwOutputNum,[In] ASF_SELECTION_STATUS Selection)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::SetOutputOverride</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.GetOutputMutexCount(System.Int32,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of mutual exclusion objects associated with an output.</p>
|
|
</summary>
|
|
<param name="dwOutputNum"><dd> <p>Output number for which to retrieve the count of mutually exclusive relationships.</p> </dd></param>
|
|
<param name="cMutexesRef"><dd> <p>Receives the number of mutual exclusions.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::GetOutputMutexCount']/*"/>
|
|
<msdn-id>ms703918</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::GetOutputMutexCount([In] unsigned int dwOutputNum,[In] unsigned int* pcMutexes)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::GetOutputMutexCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.GetOutputMutex(System.Int32,System.Int32,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves a mutual exclusion object for an output.</p>
|
|
</summary>
|
|
<param name="dwOutputNum"><dd> <p>Output number for which to retrieve a mutual exclusion object.</p> </dd></param>
|
|
<param name="dwMutexNum"><dd> <p>Mutual exclusion number. This is an index of mutually exclusive relationships associated with the output. Set to a number between 0, and 1 less than the number of mutual exclusion objects retrieved by calling <strong><see cref="M:SharpDX.MediaFoundation.ASFStreamSelector.GetOutputMutexCount(System.Int32,System.Int32)"/></strong>.</p> </dd></param>
|
|
<param name="mutexOut"><dd> <p>Receives a reference to the mutual exclusion object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Outputs are streams in the ASF data section that will be parsed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::GetOutputMutex']/*"/>
|
|
<msdn-id>ms703819</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::GetOutputMutex([In] unsigned int dwOutputNum,[In] unsigned int dwMutexNum,[In] IUnknown** ppMutex)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::GetOutputMutex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.SetOutputMutexSelection(System.Int32,System.Int32,System.Int16)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Selects a mutual exclusion record to use for a mutual exclusion object associated with an output.</p>
|
|
</summary>
|
|
<param name="dwOutputNum"><dd> <p>The output number for which to set a stream.</p> </dd></param>
|
|
<param name="dwMutexNum"><dd> <p>Index of the mutual exclusion for which to select.</p> </dd></param>
|
|
<param name="wSelectedRecord"><dd> <p>Record of the specified mutual exclusion to select.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>An output is a stream in an Advanced Systems Format (ASF) data section that will be parsed. If mutual exclusion is used, mutually exclusive streams share the same output.</p><p>An ASF file can contain multiple mutually exclusive relationships, such as a file with both language based and bit-rate based mutual exclusion. If an output is involved in multiple mutually exclusive relationships, a record from each must be selected.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::SetOutputMutexSelection']/*"/>
|
|
<msdn-id>ms704822</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::SetOutputMutexSelection([In] unsigned int dwOutputNum,[In] unsigned int dwMutexNum,[In] unsigned short wSelectedRecord)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::SetOutputMutexSelection</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.GetBandwidthStepCount(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of bandwidth steps that exist for the content. This method is used for multiple bit rate (MBR) content.</p>
|
|
</summary>
|
|
<param name="cStepCountRef"><dd> <p>Receives the number of bandwidth steps.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Bandwidth steps are bandwidth levels used for multiple bit rate (MBR) content. If you stream MBR content, you can choose the bandwidth step that matches the network conditions to avoid interruptions during playback.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::GetBandwidthStepCount']/*"/>
|
|
<msdn-id>ms698868</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::GetBandwidthStepCount([In] unsigned int* pcStepCount)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::GetBandwidthStepCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.GetBandwidthStep(System.Int32,System.Int32,System.Int16,SharpDX.MediaFoundation.AsfSelectionStatus)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the stream numbers that apply to a bandwidth step. This method is used for multiple bit rate (MBR) content.</p>
|
|
</summary>
|
|
<param name="dwStepNum"><dd> <p>Bandwidth step number for which to retrieve information. Set this value to a number between 0, and 1 less than the number of bandwidth steps returned by <strong><see cref="M:SharpDX.MediaFoundation.ASFStreamSelector.GetBandwidthStepCount(System.Int32)"/></strong>.</p> </dd></param>
|
|
<param name="dwBitrateRef"><dd> <p>Receives the bit rate associated with the bandwidth step.</p> </dd></param>
|
|
<param name="rgwStreamNumbers"><dd> <p>Address of an array that receives the stream numbers. The caller allocates the array. The array size must be at least as large as the value returned by the <strong><see cref="M:SharpDX.MediaFoundation.ASFStreamSelector.GetStreamCount(System.Int32)"/></strong> method.</p> </dd></param>
|
|
<param name="rgSelections"><dd> <p>Address of an array that receives the selection status of each stream, as an <strong><see cref="T:SharpDX.MediaFoundation.AsfSelectionStatus"/></strong> value. The members of this array correspond to the members of the <em>rgwStreamNumbers</em> array by index. The caller allocates the array. The array size must be at least as large as the value returned by the <strong><see cref="M:SharpDX.MediaFoundation.ASFStreamSelector.GetStreamCount(System.Int32)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Bandwidth steps are bandwidth levels used for MBR content. If you stream MBR content, you can choose the bandwidth step that matches the network conditions to avoid interruptions during playback.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::GetBandwidthStep']/*"/>
|
|
<msdn-id>ms700131</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::GetBandwidthStep([In] unsigned int dwStepNum,[In] unsigned int* pdwBitrate,[In] unsigned short* rgwStreamNumbers,[In] ASF_SELECTION_STATUS* rgSelections)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::GetBandwidthStep</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.BitrateToStepNumber(System.Int32,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the index of a bandwidth step that is appropriate for a specified bit rate. This method is used for multiple bit rate (MBR) content.</p>
|
|
</summary>
|
|
<param name="dwBitrate"><dd> <p>The bit rate to find a bandwidth step for.</p> </dd></param>
|
|
<param name="dwStepNumRef"><dd> <p>Receives the step number. Use this number to retrieve information about the step by calling <strong><see cref="M:SharpDX.MediaFoundation.ASFStreamSelector.GetBandwidthStep(System.Int32,System.Int32,System.Int16,SharpDX.MediaFoundation.AsfSelectionStatus)"/></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>In a streaming multiple bit rate (MBR) scenario, call this method with the current data rate of the network connection to determine the correct step to use. You can also call this method periodically throughout streaming to ensure that the best step is used.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::BitrateToStepNumber']/*"/>
|
|
<msdn-id>ms704645</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::BitrateToStepNumber([In] unsigned int dwBitrate,[In] unsigned int* pdwStepNum)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::BitrateToStepNumber</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ASFStreamSelector.SetStreamSelectorFlags(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets options for the stream selector.</p>
|
|
</summary>
|
|
<param name="dwStreamSelectorFlags"><dd> <p>Bitwise <strong>OR</strong> of zero or more members of the <strong>MFASF_STREAMSELECTOR_FLAGS</strong> enumeration specifying the options to use.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::SetStreamSelectorFlags']/*"/>
|
|
<msdn-id>ms701635</msdn-id>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::SetStreamSelectorFlags([In] unsigned int dwStreamSelectorFlags)</unmanaged>
|
|
<unmanaged-short>IMFASFStreamSelector::SetStreamSelectorFlags</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ASFStreamSelector.StreamSelectorFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets options for the stream selector.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFASFStreamSelector::SetStreamSelectorFlags']/*"/>
|
|
<msdn-id>ms701635</msdn-id>
|
|
<unmanaged>SetStreamSelectorFlags</unmanaged>
|
|
<unmanaged-short>SetStreamSelectorFlags</unmanaged-short>
|
|
<unmanaged>HRESULT IMFASFStreamSelector::SetStreamSelectorFlags([In] unsigned int dwStreamSelectorFlags)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsyncCallback">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Callback interface to notify the application when an asynchronous method completes. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> For more information about asynchronous methods in Microsoft Media Foundation, see Asynchronous Callback Methods. </p><p>This interface is also used to perform a work item in a Media Foundation work-queue. For more information, see Work Queues. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncCallback']/*"/>
|
|
<msdn-id>ms699856</msdn-id>
|
|
<unmanaged>IMFAsyncCallback</unmanaged>
|
|
<unmanaged-short>IMFAsyncCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncCallback.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.AsyncCallback"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncCallback.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.AsyncCallback">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.AsyncCallback"/>. (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.MediaFoundation.AsyncCallback.GetParameters(System.Int32@,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Provides configuration information to the dispatching thread for a callback.</p>
|
|
</summary>
|
|
<param name="dwFlagsRef"><dd> <p>Receives a flag indicating the behavior of the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. The following values are defined. The default value is zero.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>Zero</strong></dt> </dl> </td><td> <p>The callback does not take a long time to complete, but has no specific restrictions on what system calls it makes. The callback generally takes less than 30 milliseconds to complete.</p> </td></tr> <tr><td><dl> <dt><strong><strong>MFASYNC_FAST_IO_PROCESSING_CALLBACK</strong></strong></dt> </dl> </td><td> <p>The callback does very minimal processing. It takes less than 1 millisecond to complete.</p> <p>The callback must be invoked from one of the following work queues:</p> <ul> <li><strong>MFASYNC_CALLBACK_QUEUE_IO</strong></li> <li><strong>MFASYNC_CALLBACK_QUEUE_TIMER</strong></li> </ul> </td></tr> <tr><td><dl> <dt><strong><strong>MFASYNC_SIGNAL_CALLBACK</strong></strong></dt> </dl> </td><td> <p>Implies <strong>MFASYNC_FAST_IO_PROCESSING_CALLBACK</strong>, with the additional restriction that the callback does no processing (less than 50 microseconds), and the only system call it makes is <strong>SetEvent</strong>.</p> <p>The callback must be invoked from one of the following work queues:</p> <ul> <li><strong>MFASYNC_CALLBACK_QUEUE_IO</strong></li> <li><strong>MFASYNC_CALLBACK_QUEUE_TIMER</strong></li> </ul> </td></tr> <tr><td><dl> <dt><strong><strong>MFASYNC_BLOCKING_CALLBACK</strong></strong></dt> </dl> </td><td> <p>Blocking callback.</p> </td></tr> <tr><td><dl> <dt><strong><strong>MFASYNC_REPLY_CALLBACK</strong></strong></dt> </dl> </td><td> <p>Reply callback.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="dwQueueRef"><dd> <p> Receives the identifier of the work queue on which the callback is dispatched. </p> <p>This value can specify one of the standard Media Foundation work queues, or a work queue created by the application. For list of standard Media Foundation work queues, see <strong>Work Queue Identifiers</strong>. To create a new work queue, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.AllocateWorkQueue(System.Int32@)"/></strong>. The default value is <strong>MFASYNC_CALLBACK_QUEUE_STANDARD</strong>.</p> <p>If the work queue is not compatible with the value returned in <em>pdwFlags</em>, the Media Foundation platform returns <strong>MF_E_INVALID_WORKQUEUE</strong> when it tries to dispatch the callback. (See <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItem(System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.)</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_NOTIMPL</strong></strong></dt> </dl> </td><td> <p> Not implemented. Assume the default behavior. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> The <strong>GetParameters</strong> method returns information about the callback so that the dispatching thread can optimize the process that it uses to invoke the callback. </p><p> If the method returns a value other than zero in the <em>pdwFlags</em> parameter, your <strong>Invoke</strong> method must meet the requirements described here. Otherwise, the callback might delay the pipeline.</p><p> If you want default values for both parameters, return <strong>E_NOTIMPL</strong>. The default values are given in the parameter descriptions on this page.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncCallback::GetParameters']/*"/>
|
|
<msdn-id>bb970381</msdn-id>
|
|
<unmanaged>HRESULT IMFAsyncCallback::GetParameters([Out] unsigned int* pdwFlags,[Out] unsigned int* pdwQueue)</unmanaged>
|
|
<unmanaged-short>IMFAsyncCallback::GetParameters</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Called when an asynchronous operation is completed.</p>
|
|
</summary>
|
|
<param name="asyncResultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass this reference to the asynchronous <strong>End...</strong> method to complete the asynchronous call.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Within your implementation of <strong>Invoke</strong>, call the corresponding <strong>End...</strong> method.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncCallback::Invoke']/*"/>
|
|
<msdn-id>bb970360</msdn-id>
|
|
<unmanaged>HRESULT IMFAsyncCallback::Invoke([In, Optional] IMFAsyncResult* pAsyncResult)</unmanaged>
|
|
<unmanaged-short>IMFAsyncCallback::Invoke</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsyncCallbackLogging">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncCallbackLogging']/*"/>
|
|
<unmanaged>IMFAsyncCallbackLogging</unmanaged>
|
|
<unmanaged-short>IMFAsyncCallbackLogging</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncCallbackLogging.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.AsyncCallbackLogging"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncCallbackLogging.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.AsyncCallbackLogging">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.AsyncCallbackLogging"/>. (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.MediaFoundation.AsyncCallbackLogging.GetObjectPointer">
|
|
<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='IMFAsyncCallbackLogging::GetObjectPointer']/*"/>
|
|
<unmanaged>void* IMFAsyncCallbackLogging::GetObjectPointer()</unmanaged>
|
|
<unmanaged-short>IMFAsyncCallbackLogging::GetObjectPointer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncCallbackLogging.GetObjectTag">
|
|
<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='IMFAsyncCallbackLogging::GetObjectTag']/*"/>
|
|
<unmanaged>unsigned int IMFAsyncCallbackLogging::GetObjectTag()</unmanaged>
|
|
<unmanaged-short>IMFAsyncCallbackLogging::GetObjectTag</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.AsyncCallbackLogging.ObjectPointer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncCallbackLogging::GetObjectPointer']/*"/>
|
|
<unmanaged>GetObjectPointer</unmanaged>
|
|
<unmanaged-short>GetObjectPointer</unmanaged-short>
|
|
<unmanaged>void* IMFAsyncCallbackLogging::GetObjectPointer()</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.AsyncCallbackLogging.ObjectTag">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncCallbackLogging::GetObjectTag']/*"/>
|
|
<unmanaged>GetObjectTag</unmanaged>
|
|
<unmanaged-short>GetObjectTag</unmanaged-short>
|
|
<unmanaged>unsigned int IMFAsyncCallbackLogging::GetObjectTag()</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsyncResult">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Provides information about the result of an asynchronous operation. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Use this interface to complete an asynchronous operation. You get a reference to this interface when your callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. To complete the operation, pass the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> reference to the <strong>End...</strong> method that corresponds to the <strong>Begin...</strong> method that starts the operation. For example, if the asynchronous method is named <strong>BeginRead</strong>, call the <strong>EndRead</strong> method. For more information, see Calling Asynchronous Methods.</p><p>If you are implementing an asynchronous method, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong> to create an instance of this object. For more information, see Writing an Asynchronous Method.</p><p>Any custom implementation of this interface must inherit the <strong><see cref="T:SharpDX.MediaFoundation.Mfasyncresult"/></strong> structure.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncResult']/*"/>
|
|
<msdn-id>ms700196</msdn-id>
|
|
<unmanaged>IMFAsyncResult</unmanaged>
|
|
<unmanaged-short>IMFAsyncResult</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncResult.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.AsyncResult"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncResult.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.AsyncResult">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.AsyncResult"/>. (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.MediaFoundation.AsyncResult.GetState(SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Returns the state object specified by the caller in the asynchronous <strong>Begin</strong> method.</p>
|
|
</summary>
|
|
<param name="unkStateOut"><dd> <p>Receives a reference to the state object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. If the value is not <strong><c>null</c></strong>, the caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_POINTER</strong></dt> </dl> </td><td> <p>There is no state object associated with this asynchronous result.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The caller of the asynchronous method specifies the state object, and can use it for any caller-defined purpose. The state object can be <strong><c>null</c></strong>. If the state object is <strong><c>null</c></strong>, <strong>GetState</strong> returns <strong>E_POINTER</strong>.</p><p>If you are implementing an asynchronous method, set the state object on the through the <em>punkState</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong> function.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncResult::GetState']/*"/>
|
|
<msdn-id>bb970576</msdn-id>
|
|
<unmanaged>HRESULT IMFAsyncResult::GetState([Out] IUnknown** ppunkState)</unmanaged>
|
|
<unmanaged-short>IMFAsyncResult::GetState</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncResult.GetStatus">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Returns the status of the asynchronous operation.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The operation completed successfully.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncResult::GetStatus']/*"/>
|
|
<msdn-id>ms702095</msdn-id>
|
|
<unmanaged>HRESULT IMFAsyncResult::GetStatus()</unmanaged>
|
|
<unmanaged-short>IMFAsyncResult::GetStatus</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncResult.SetStatus(SharpDX.Result)">
|
|
<summary>
|
|
<p>Sets the status of the asynchronous operation.</p> <see cref="T:SharpDX.Result"/> SetStatus( <see cref="T:SharpDX.Result"/> hrStatus
|
|
);<p></p>Parameters <p> hrStatus </p> <p>The status of the asynchronous operation.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr></table> <p>If you implement an asynchronous method, call SetStatus to set the status code for the operation. </p> <p> Client: Requires Windows Vista.</p> <p> Header: Defined in mfobjects.h; include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFAsyncResult InterfaceConceptsAsynchronous Callback Methods
|
|
</summary>
|
|
<param name="hrStatus">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='IMFAsyncResult::SetStatus']/*"/>
|
|
<msdn-id>ms697440</msdn-id>
|
|
<unmanaged>HRESULT IMFAsyncResult::SetStatus([In] HRESULT hrStatus)</unmanaged>
|
|
<unmanaged-short>IMFAsyncResult::SetStatus</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncResult.GetObjectW(SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Returns an object associated with the asynchronous operation. The type of object, if any, depends on the asynchronous method that was called.</p>
|
|
</summary>
|
|
<param name="objectOut"><dd> <p>Receives a reference to the object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. If no object is associated with the operation, this parameter receives the value <strong><c>null</c></strong>. If the value is not <strong><c>null</c></strong>, the caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_POINTER</strong></dt> </dl> </td><td> <p>There is no object associated with this asynchronous result.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Typically, this object is used by the component that implements the asynchronous method. It provides a way for the function that invokes the callback to pass information to the asynchronous <strong>End...</strong> method that completes the operation.</p><p>If you are implementing an asynchronous method, you can set the object through the <em>punkObject</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong> function.</p><p>If the asynchronous result object's internal <strong><see cref="T:SharpDX.ComObject"/></strong> reference is <strong><c>null</c></strong>, the method returns <strong>E_POINTER</strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncResult::GetObjectW']/*"/>
|
|
<msdn-id>bb970500</msdn-id>
|
|
<unmanaged>HRESULT IMFAsyncResult::GetObjectW([Out] IUnknown** ppObject)</unmanaged>
|
|
<unmanaged-short>IMFAsyncResult::GetObjectW</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AsyncResult.GetStateNoAddRef">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Returns the state object specified by the caller in the asynchronous <strong>Begin</strong> method, without incrementing the object's reference count.</p>
|
|
</summary>
|
|
<returns><p>Returns a reference to the state object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface, or <strong><c>null</c></strong> if no object was set. This reference does not have an outstanding reference count. If you store this reference, you must call <strong>AddRef</strong> on the reference.</p></returns>
|
|
<remarks>
|
|
<p>This method cannot be called remotely.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncResult::GetStateNoAddRef']/*"/>
|
|
<msdn-id>ms696238</msdn-id>
|
|
<unmanaged>IUnknown* IMFAsyncResult::GetStateNoAddRef()</unmanaged>
|
|
<unmanaged-short>IMFAsyncResult::GetStateNoAddRef</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.AsyncResult.State">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Returns the state object specified by the caller in the asynchronous <strong>Begin</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The caller of the asynchronous method specifies the state object, and can use it for any caller-defined purpose. The state object can be <strong><c>null</c></strong>. If the state object is <strong><c>null</c></strong>, <strong>GetState</strong> returns <strong>E_POINTER</strong>.</p><p>If you are implementing an asynchronous method, set the state object on the through the <em>punkState</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong> function.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncResult::GetState']/*"/>
|
|
<msdn-id>bb970576</msdn-id>
|
|
<unmanaged>GetState</unmanaged>
|
|
<unmanaged-short>GetState</unmanaged-short>
|
|
<unmanaged>HRESULT IMFAsyncResult::GetState([Out] IUnknown** ppunkState)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.AsyncResult.Status">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Returns the status of the asynchronous operation.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncResult::GetStatus']/*"/>
|
|
<msdn-id>ms702095</msdn-id>
|
|
<unmanaged>GetStatus</unmanaged>
|
|
<unmanaged-short>GetStatus</unmanaged-short>
|
|
<unmanaged>HRESULT IMFAsyncResult::GetStatus()</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.AsyncResult.ObjectW">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Returns an object associated with the asynchronous operation. The type of object, if any, depends on the asynchronous method that was called.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Typically, this object is used by the component that implements the asynchronous method. It provides a way for the function that invokes the callback to pass information to the asynchronous <strong>End...</strong> method that completes the operation.</p><p>If you are implementing an asynchronous method, you can set the object through the <em>punkObject</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong> function.</p><p>If the asynchronous result object's internal <strong><see cref="T:SharpDX.ComObject"/></strong> reference is <strong><c>null</c></strong>, the method returns <strong>E_POINTER</strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncResult::GetObjectW']/*"/>
|
|
<msdn-id>bb970500</msdn-id>
|
|
<unmanaged>GetObjectW</unmanaged>
|
|
<unmanaged-short>GetObjectW</unmanaged-short>
|
|
<unmanaged>HRESULT IMFAsyncResult::GetObjectW([Out] IUnknown** ppObject)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.AsyncResult.StateNoAddRef">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Returns the state object specified by the caller in the asynchronous <strong>Begin</strong> method, without incrementing the object's reference count.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method cannot be called remotely.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAsyncResult::GetStateNoAddRef']/*"/>
|
|
<msdn-id>ms696238</msdn-id>
|
|
<unmanaged>GetStateNoAddRef</unmanaged>
|
|
<unmanaged-short>GetStateNoAddRef</unmanaged-short>
|
|
<unmanaged>IUnknown* IMFAsyncResult::GetStateNoAddRef()</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AudioMediaType">
|
|
<summary>
|
|
<p>[<strong><see cref="T:SharpDX.MediaFoundation.AudioMediaType"/></strong> is no longer available for use as of Windows?7. Instead, use the media type attributes to get the properties of the audio format.]</p><p><strong>Applies to: </strong>desktop apps only</p><p> Represents a description of an audio format.</p>
|
|
</summary>
|
|
<remarks>
|
|
<strong>Windows Server?2008 and Windows?Vista:??</strong>If the major type of a media type is <strong>MFMediaType_Audio</strong>, you can query the media type object for the <strong><see cref="T:SharpDX.MediaFoundation.AudioMediaType"/></strong> interface.<p> To convert an audio media type into a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateWaveFormatExFromMFMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.Multimedia.WaveFormat@,System.Int32@,System.Int32)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioMediaType']/*"/>
|
|
<msdn-id>aa473793</msdn-id>
|
|
<unmanaged>IMFAudioMediaType</unmanaged>
|
|
<unmanaged-short>IMFAudioMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Represents a description of a media format. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> To create a new media type, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaType(SharpDX.MediaFoundation.MediaType@)"/></strong>. </p><p> All of the information in a media type is stored as attributes. To clone a media type, call <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.CopyAllItems(SharpDX.MediaFoundation.MediaAttributes)"/></strong>. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaType']/*"/>
|
|
<msdn-id>ms704850</msdn-id>
|
|
<unmanaged>IMFMediaType</unmanaged>
|
|
<unmanaged-short>IMFMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaType.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaType"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaType.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaType">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaType"/>. (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.MediaFoundation.MediaType.GetMajorType(System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the major type of the format. </p>
|
|
</summary>
|
|
<param name="guidMajorTypeRef"><dd> <p>Receives the major type <strong><see cref="T:System.Guid"/></strong>. The major type describes the broad category of the format, such as audio or video. For a list of possible values, see Major Media Types. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ATTRIBUTENOTFOUND</strong></dt> </dl> </td><td> <p> The major type is not set. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> This method is equivalent to getting the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.MajorType"/></strong> attribute from the media type. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaType::GetMajorType']/*"/>
|
|
<msdn-id>ms701588</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaType::GetMajorType([Out] GUID* pguidMajorType)</unmanaged>
|
|
<unmanaged-short>IMFMediaType::GetMajorType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaType.IsCompressedFormat_(System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Queries whether the media type is a temporally compressed format. Temporal compression uses information from previously decoded samples when decompressing the current sample.</p>
|
|
</summary>
|
|
<param name="fCompressedRef"><dd> <p>Receives a Boolean value. The value is <strong>TRUE</strong> if the format uses temporal compression, or <strong><see cref="F:SharpDX.Result.False"/></strong> if the format does not use temporal compression.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This method returns <strong><see cref="F:SharpDX.Result.False"/></strong> in <em>pfCompressed</em> if the media type's <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AllSamplesIndependent"/></strong> attribute is <strong>TRUE</strong>. If the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AllSamplesIndependent"/></strong> attribute is <strong><see cref="F:SharpDX.Result.False"/></strong> or not set, the method returns <strong>TRUE</strong>. </p><p> If the method returns <strong>TRUE</strong> in <em>pfCompressed</em>, it is a hint that the format has temporal compression applied to it. If the method returns <strong><see cref="F:SharpDX.Result.False"/></strong>, the format does not use temporal compression, although it might use intra-frame compression. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaType::IsCompressedFormat']/*"/>
|
|
<msdn-id>ms703821</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaType::IsCompressedFormat([Out] BOOL* pfCompressed)</unmanaged>
|
|
<unmanaged-short>IMFMediaType::IsCompressedFormat</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaType.IsEqual(SharpDX.MediaFoundation.MediaType,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Compares two media types and determines whether they are identical. If they are not identical, the method indicates how the two formats differ. </p>
|
|
</summary>
|
|
<param name="iMediaTypeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type to compare.</p> </dd></param>
|
|
<param name="dwFlagsRef"><dd> <p>Receives a bitwise <strong>OR</strong> of zero or more flags, indicating the degree of similarity between the two media types. The following flags are defined.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>MF_MEDIATYPE_EQUAL_MAJOR_TYPES</strong></dt> <dt>0x00000001</dt> </dl> </td><td> <p>The major types are the same. The major type is specified by the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.MajorType"/></strong> attribute.</p> </td></tr> <tr><td><dl> <dt><strong>MF_MEDIATYPE_EQUAL_FORMAT_TYPES</strong></dt> <dt>0x00000002</dt> </dl> </td><td> <p>The subtypes are the same, or neither media type has a subtype. The subtype is specified by the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.Subtype"/></strong> attribute.</p> </td></tr> <tr><td><dl> <dt><strong>MF_MEDIATYPE_EQUAL_FORMAT_DATA</strong></dt> <dt>0x00000004</dt> </dl> </td><td> <p>The attributes in one of the media types are a subset of the attributes in the other, and the values of these attributes match, excluding the value of the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.UserData"/></strong> attribute.</p> <p>Specifically, the method takes the media type with the smaller number of attributes and checks whether each attribute from that type is present in the other media type and has the same value (not including <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.UserData"/></strong>). </p> <p>To perform other comparisons, use the <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.Compare(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.AttributesMatchType)"/></strong> method. For example, the <strong>Compare</strong> method can test for identical attributes, or test the intersection of the two attribute sets. For more information, see <strong><see cref="T:SharpDX.MediaFoundation.AttributesMatchType"/></strong>.</p> </td></tr> <tr><td><dl> <dt><strong>MF_MEDIATYPE_EQUAL_FORMAT_USER_DATA</strong></dt> <dt>0x00000008</dt> </dl> </td><td> <p>The user data is identical, or neither media type contains user data. User data is specified by the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.UserData"/></strong> attribute.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>S_FALSE</strong></dt> </dl> </td><td> <p> The types are not equal. Examine the <em>pdwFlags</em> parameter to determine how the types differ. </p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The types are equal. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> One or both media types are invalid. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> Both of the media types must have a major type, or the method returns <strong>E_INVALIDARG</strong>. </p><p> If the method succeeds and all of the comparison flags are set in <em>pdwFlags</em>, the return value is <strong><see cref="F:SharpDX.Result.Ok"/></strong>. If the method succeeds but one or more comparison flags are not set, the method returns <strong>S_FALSE</strong>. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaType::IsEqual']/*"/>
|
|
<msdn-id>ms696980</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaType::IsEqual([In] IMFMediaType* pIMediaType,[Out] unsigned int* pdwFlags)</unmanaged>
|
|
<unmanaged-short>IMFMediaType::IsEqual</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaType.GetRepresentation(System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves an alternative representation of the media type. Currently only the DirectShow <strong><see cref="!:SharpDX.Win32.Unsupported.AMMediaType"/></strong> structure is supported.</p>
|
|
</summary>
|
|
<param name="guidRepresentation"><dd> <p> <see cref="T:System.Guid"/> that specifies the representation to retrieve. The following values are defined. </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>AM_MEDIA_TYPE_REPRESENTATION</strong></dt> </dl> </td><td> <p> Convert the media type to a DirectShow <strong><see cref="!:SharpDX.Win32.Unsupported.AMMediaType"/></strong> structure. The method selects the most appropriate format structure (<strong>pbFormat</strong>). </p> </td></tr> <tr><td><dl> <dt><strong>FORMAT_MFVideoFormat</strong></dt> </dl> </td><td> <p> Convert the media type to a DirectShow <strong><see cref="!:SharpDX.Win32.Unsupported.AMMediaType"/></strong> structure with an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> format structure. </p> </td></tr> <tr><td><dl> <dt><strong>FORMAT_VideoInfo</strong></dt> </dl> </td><td> <p> Convert the media type to a DirectShow <strong><see cref="!:SharpDX.Win32.Unsupported.AMMediaType"/></strong> structure with a <strong><see cref="!:SharpDX.Win32.Unsupported.VideoInfoHeader"/></strong> format structure. </p> </td></tr> <tr><td><dl> <dt><strong>FORMAT_VideoInfo2</strong></dt> </dl> </td><td> <p> Convert the media type to a DirectShow <strong><see cref="!:SharpDX.Win32.Unsupported.AMMediaType"/></strong> structure with a <strong><see cref="!:SharpDX.MediaFoundation.VideoInformationHeader2"/></strong> format structure. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="vRepresentationOut"><dd> <p> Receives a reference to a structure that contains the representation. The method allocates the memory for the structure. The caller must release the memory by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaType.FreeRepresentation(System.Guid,System.IntPtr)"/></strong>. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ATTRIBUTENOTFOUND</strong></dt> </dl> </td><td> <p> The details of the media type do not match the requested representation. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDMEDIATYPE</strong></dt> </dl> </td><td> <p> The media type is not valid. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_REPRESENTATION</strong></dt> </dl> </td><td> <p> The media type does not support the requested representation. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If you request a specific format structure in the <em>guidRepresentation</em> parameter, such as <strong><see cref="!:SharpDX.Win32.Unsupported.VideoInfoHeader"/></strong>, you might lose some of the format information. </p><p> You can also use the <strong>MFInitAMMediaTypeFromMFMediaType</strong> function to convert a Media Foundation media type into a DirectShow media type. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaType::GetRepresentation']/*"/>
|
|
<msdn-id>ms695248</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaType::GetRepresentation([In] GUID guidRepresentation,[Out] void** ppvRepresentation)</unmanaged>
|
|
<unmanaged-short>IMFMediaType::GetRepresentation</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaType.FreeRepresentation(System.Guid,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Frees memory that was allocated by the <strong><see cref="M:SharpDX.MediaFoundation.MediaType.GetRepresentation(System.Guid,System.IntPtr@)"/></strong> method.</p>
|
|
</summary>
|
|
<param name="guidRepresentation">No documentation.</param>
|
|
<param name="vRepresentationRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaType::FreeRepresentation']/*"/>
|
|
<msdn-id>ms703846</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaType::FreeRepresentation([In] GUID guidRepresentation,[In] void* pvRepresentation)</unmanaged>
|
|
<unmanaged-short>IMFMediaType::FreeRepresentation</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaType.MajorType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the major type of the format. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> This method is equivalent to getting the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.MajorType"/></strong> attribute from the media type. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaType::GetMajorType']/*"/>
|
|
<msdn-id>ms701588</msdn-id>
|
|
<unmanaged>GetMajorType</unmanaged>
|
|
<unmanaged-short>GetMajorType</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaType::GetMajorType([Out] GUID* pguidMajorType)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaType.IsCompressedFormat">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Queries whether the media type is a temporally compressed format. Temporal compression uses information from previously decoded samples when decompressing the current sample.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> This method returns <strong><see cref="F:SharpDX.Result.False"/></strong> in <em>pfCompressed</em> if the media type's <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AllSamplesIndependent"/></strong> attribute is <strong>TRUE</strong>. If the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AllSamplesIndependent"/></strong> attribute is <strong><see cref="F:SharpDX.Result.False"/></strong> or not set, the method returns <strong>TRUE</strong>. </p><p> If the method returns <strong>TRUE</strong> in <em>pfCompressed</em>, it is a hint that the format has temporal compression applied to it. If the method returns <strong><see cref="F:SharpDX.Result.False"/></strong>, the format does not use temporal compression, although it might use intra-frame compression. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaType::IsCompressedFormat']/*"/>
|
|
<msdn-id>ms703821</msdn-id>
|
|
<unmanaged>IsCompressedFormat</unmanaged>
|
|
<unmanaged-short>IsCompressedFormat</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaType::IsCompressedFormat([Out] BOOL* pfCompressed)</unmanaged>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioMediaType.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.AudioMediaType"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioMediaType.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.AudioMediaType">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.AudioMediaType"/>. (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.MediaFoundation.AudioMediaType.GetAudioFormat">
|
|
<summary>
|
|
<p>[<strong>GetAudioFormat</strong> is no longer available for use as of Windows?7. Instead, use the media type attributes to get the properties of the audio format.]</p><p><strong>Applies to: </strong>desktop apps only</p><p> Returns a reference to a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure that describes the audio format.</p>
|
|
</summary>
|
|
<returns><p> This method returns a reference to a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure.</p></returns>
|
|
<remarks>
|
|
<p>If you need to convert the media type into a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateWaveFormatExFromMFMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.Multimedia.WaveFormat@,System.Int32@,System.Int32)"/></strong>.</p><p> There are no guarantees about how long the returned reference is valid.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioMediaType::GetAudioFormat']/*"/>
|
|
<msdn-id>aa473803</msdn-id>
|
|
<unmanaged>const WAVEFORMATEX* IMFAudioMediaType::GetAudioFormat()</unmanaged>
|
|
<unmanaged-short>IMFAudioMediaType::GetAudioFormat</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.AudioMediaType.AudioFormat">
|
|
<summary>
|
|
<p>[<strong>GetAudioFormat</strong> is no longer available for use as of Windows?7. Instead, use the media type attributes to get the properties of the audio format.]</p><p><strong>Applies to: </strong>desktop apps only</p><p> Returns a reference to a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure that describes the audio format.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If you need to convert the media type into a <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> structure, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateWaveFormatExFromMFMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.Multimedia.WaveFormat@,System.Int32@,System.Int32)"/></strong>.</p><p> There are no guarantees about how long the returned reference is valid.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioMediaType::GetAudioFormat']/*"/>
|
|
<msdn-id>aa473803</msdn-id>
|
|
<unmanaged>GetAudioFormat</unmanaged>
|
|
<unmanaged-short>GetAudioFormat</unmanaged-short>
|
|
<unmanaged>const WAVEFORMATEX* IMFAudioMediaType::GetAudioFormat()</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AudioPolicy">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the display name of the audio session. The Windows volume control displays this name.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the application does not set a display name, Windows creates one.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioPolicy']/*"/>
|
|
<msdn-id>ms697038</msdn-id>
|
|
<unmanaged>IMFAudioPolicy</unmanaged>
|
|
<unmanaged-short>IMFAudioPolicy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioPolicy.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.AudioPolicy"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioPolicy.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.AudioPolicy">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.AudioPolicy"/>. (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.MediaFoundation.AudioPolicy.SetGroupingParam(System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Assigns the audio session to a group of sessions.</p>
|
|
</summary>
|
|
<param name="rguidClass"><dd> <p>A <strong><see cref="T:System.Guid"/></strong> that identifies the session group. Groups are application-defined. To create a new session group, assign a new <see cref="T:System.Guid"/>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If two or more audio sessions share the same group, the Windows volume control displays one slider control for the entire group. Otherwise, it displays a slider for each session. For more information, see <strong>IAudioSessionControl::SetGroupingParam</strong> in the core audio API documentation.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioPolicy::SetGroupingParam']/*"/>
|
|
<msdn-id>ms696185</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioPolicy::SetGroupingParam([In] const GUID& rguidClass)</unmanaged>
|
|
<unmanaged-short>IMFAudioPolicy::SetGroupingParam</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioPolicy.GetGroupingParam(System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the group of sessions to which this audio session belongs.</p>
|
|
</summary>
|
|
<param name="guidClassRef"><dd> <p>Receives a <see cref="T:System.Guid"/> that identifies the session group.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If two or more audio sessions share the same group, the Windows volume control displays one slider control for the entire group. Otherwise, it displays a slider for each session. For more information, see <strong>IAudioSessionControl::SetGroupingParam</strong> in the core audio API documentation.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioPolicy::GetGroupingParam']/*"/>
|
|
<msdn-id>ms698967</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioPolicy::GetGroupingParam([Out] GUID* pguidClass)</unmanaged>
|
|
<unmanaged-short>IMFAudioPolicy::GetGroupingParam</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioPolicy.SetDisplayName(System.String)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the display name of the audio session. The Windows volume control displays this name.</p>
|
|
</summary>
|
|
<param name="szNameRef"><dd> <p>A null-terminated wide-character string that contains the display name.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the application does not set a display name, Windows creates one.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioPolicy::SetDisplayName']/*"/>
|
|
<msdn-id>ms697038</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioPolicy::SetDisplayName([In] const wchar_t* pszName)</unmanaged>
|
|
<unmanaged-short>IMFAudioPolicy::SetDisplayName</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioPolicy.GetDisplayName(System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the display name of the audio session. The Windows volume control displays this name.</p>
|
|
</summary>
|
|
<param name="szNameRef"><dd> <p>Receives a reference to the display name string. The caller must free the memory allocated for the string by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the application does not set a display name, Windows creates one.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioPolicy::GetDisplayName']/*"/>
|
|
<msdn-id>ms698992</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioPolicy::GetDisplayName([Out] wchar_t** pszName)</unmanaged>
|
|
<unmanaged-short>IMFAudioPolicy::GetDisplayName</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioPolicy.SetIconPath(System.String)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Sets the icon resource for the audio session. The Windows volume control displays this icon. </p>
|
|
</summary>
|
|
<param name="szPathRef"><dd> <p>A wide-character string that specifies the icon. See Remarks.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The icon path has the format "path,index" or "path,-id", where <em>path</em> is the fully qualified path to a DLL, executable file, or icon file; <em>index</em> is the zero-based index of the icon within the file; and <em>id</em> is a resource identifier. Note that resource identifiers are preceded by a minus sign (-) to distinguish them from indexes. The path can contain environment variables, such as "%windir%". For more information, see <strong>IAudioSessionControl::SetIconPath</strong> in the Windows SDK.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioPolicy::SetIconPath']/*"/>
|
|
<msdn-id>ms694065</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioPolicy::SetIconPath([In] const wchar_t* pszPath)</unmanaged>
|
|
<unmanaged-short>IMFAudioPolicy::SetIconPath</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioPolicy.GetIconPath(System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the icon resource for the audio session. The Windows volume control displays this icon.</p>
|
|
</summary>
|
|
<param name="szPathRef"><dd> <p>Receives a reference to a wide-character string that specifies a shell resource. The format of the string is described in the topic <strong><see cref="M:SharpDX.MediaFoundation.AudioPolicy.SetIconPath(System.String)"/></strong>. The caller must free the memory allocated for the string by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the application did not set an icon path, the method returns an empty string ("").</p><p>For more information, see <strong>IAudioSessionControl::GetIconPath</strong> in the core audio API documentation.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioPolicy::GetIconPath']/*"/>
|
|
<msdn-id>ms704858</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioPolicy::GetIconPath([Out] wchar_t** pszPath)</unmanaged>
|
|
<unmanaged-short>IMFAudioPolicy::GetIconPath</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.AudioPolicy.GroupingParam">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the group of sessions to which this audio session belongs.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If two or more audio sessions share the same group, the Windows volume control displays one slider control for the entire group. Otherwise, it displays a slider for each session. For more information, see <strong>IAudioSessionControl::SetGroupingParam</strong> in the core audio API documentation.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioPolicy::GetGroupingParam']/*"/>
|
|
<msdn-id>ms698967</msdn-id>
|
|
<unmanaged>GetGroupingParam</unmanaged>
|
|
<unmanaged-short>GetGroupingParam</unmanaged-short>
|
|
<unmanaged>HRESULT IMFAudioPolicy::GetGroupingParam([Out] GUID* pguidClass)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AudioStreamVolume">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls the volume levels of individual audio channels.</p><p>The streaming audio renderer (SAR) exposes this interface as a service. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> with the service identifier <strong>MR_STREAM_VOLUME_SERVICE</strong>. You can call <strong>GetService</strong> directly on the SAR or call it on the Media Session.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If your application does not require channel-level volume control, you can use the <strong><see cref="T:SharpDX.MediaFoundation.SimpleAudioVolume"/></strong> interface to control the master volume level of the audio session.</p><p>Volume is expressed as an attenuation level, where 0.0 indicates silence and 1.0 indicates full volume (no attenuation). For each channel, the attenuation level is the product of:</p><ul> <li> The master volume level of the audio session. </li> <li> The volume level of the channel. </li> </ul><p>For example, if the master volume is 0.8 and the channel volume is 0.5, the attenuation for that channel is 0.8 ? 0.5 = 0.4. Volume levels can exceed 1.0 (positive gain), but the audio engine clips any audio samples that exceed zero decibels.</p><p>Use the following formula to convert the volume level to the decibel (dB) scale:</p><p>Attenuation (dB) = 20 * log10(<em>Level</em>)</p><p>For example, a volume level of 0.50 represents 6.02 dB of attenuation.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioStreamVolume']/*"/>
|
|
<msdn-id>aa378344</msdn-id>
|
|
<unmanaged>IMFAudioStreamVolume</unmanaged>
|
|
<unmanaged-short>IMFAudioStreamVolume</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioStreamVolume.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.AudioStreamVolume"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioStreamVolume.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.AudioStreamVolume">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.AudioStreamVolume"/>. (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.MediaFoundation.AudioStreamVolume.GetChannelCount(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of channels in the audio stream.</p>
|
|
</summary>
|
|
<param name="dwCountRef"><dd> <p>Receives the number of channels in the audio stream.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioStreamVolume::GetChannelCount']/*"/>
|
|
<msdn-id>aa373760</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioStreamVolume::GetChannelCount([Out] unsigned int* pdwCount)</unmanaged>
|
|
<unmanaged-short>IMFAudioStreamVolume::GetChannelCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioStreamVolume.SetChannelVolume(System.Int32,System.Single)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the volume level for a specified channel in the audio stream.</p>
|
|
</summary>
|
|
<param name="dwIndex"><dd> <p>Zero-based index of the audio channel. To get the number of channels, call <strong><see cref="M:SharpDX.MediaFoundation.AudioStreamVolume.GetChannelCount(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<param name="fLevel"><dd> <p>Volume level for the channel.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioStreamVolume::SetChannelVolume']/*"/>
|
|
<msdn-id>aa370771</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioStreamVolume::SetChannelVolume([In] unsigned int dwIndex,[In] const float fLevel)</unmanaged>
|
|
<unmanaged-short>IMFAudioStreamVolume::SetChannelVolume</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioStreamVolume.GetChannelVolume(System.Int32,System.Single@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the volume level for a specified channel in the audio stream.</p>
|
|
</summary>
|
|
<param name="dwIndex"><dd> <p>Zero-based index of the audio channel. To get the number of channels, call <strong><see cref="M:SharpDX.MediaFoundation.AudioStreamVolume.GetChannelCount(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<param name="fLevelRef"><dd> <p>Receives the volume level for the channel.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioStreamVolume::GetChannelVolume']/*"/>
|
|
<msdn-id>aa369737</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioStreamVolume::GetChannelVolume([In] unsigned int dwIndex,[Out] float* pfLevel)</unmanaged>
|
|
<unmanaged-short>IMFAudioStreamVolume::GetChannelVolume</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioStreamVolume.SetAllVolumes(System.Int32,System.Single[])">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the individual volume levels for all of the channels in the audio stream.</p>
|
|
</summary>
|
|
<param name="dwCount"><dd> <p>Number of elements in the <em>pfVolumes</em> array. The value must equal the number of channels. To get the number of channels, call <strong><see cref="M:SharpDX.MediaFoundation.AudioStreamVolume.GetChannelCount(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<param name="fVolumesRef"><dd> <p>Address of an array of size <em>dwCount</em>, allocated by the caller. The array specifies the volume levels for all of the channels. Before calling the method, set each element of the array to the desired volume level for the channel.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioStreamVolume::SetAllVolumes']/*"/>
|
|
<msdn-id>aa370454</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioStreamVolume::SetAllVolumes([In] unsigned int dwCount,[In, Buffer] const float* pfVolumes)</unmanaged>
|
|
<unmanaged-short>IMFAudioStreamVolume::SetAllVolumes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.AudioStreamVolume.GetAllVolumes(System.Int32,System.Single[])">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the volume levels for all of the channels in the audio stream.</p>
|
|
</summary>
|
|
<param name="dwCount"><dd> <p>Number of elements in the <em>pfVolumes</em> array. The value must equal the number of channels. To get the number of channels, call <strong><see cref="M:SharpDX.MediaFoundation.AudioStreamVolume.GetChannelCount(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<param name="fVolumesRef"><dd> <p>Address of an array of size <em>dwCount</em>, allocated by the caller. The method fills the array with the volume level for each channel in the stream.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioStreamVolume::GetAllVolumes']/*"/>
|
|
<msdn-id>aa373642</msdn-id>
|
|
<unmanaged>HRESULT IMFAudioStreamVolume::GetAllVolumes([In] unsigned int dwCount,[Out, Buffer] float* pfVolumes)</unmanaged>
|
|
<unmanaged-short>IMFAudioStreamVolume::GetAllVolumes</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.AudioStreamVolume.ChannelCount">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of channels in the audio stream.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFAudioStreamVolume::GetChannelCount']/*"/>
|
|
<msdn-id>aa373760</msdn-id>
|
|
<unmanaged>GetChannelCount</unmanaged>
|
|
<unmanaged-short>GetChannelCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFAudioStreamVolume::GetChannelCount([Out] unsigned int* pdwCount)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Buffer2D">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Represents a buffer that contains a two-dimensional surface, such as a video frame. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To get a reference to this interface, call <strong>QueryInterface</strong> on the media buffer.</p><p>To use a 2-D buffer, it is important to know the <em>stride</em>, which is the number of bytes needed to go from one row of pixels to the next. The stride may be larger than the image width, because the surface may contain padding bytes after each row of pixels. Stride can also be negative, if the pixels are oriented bottom-up in memory. For more information, see Image Stride.</p><p>Every video format defines a <em>contiguous</em> or <em>packed</em> representation. This representation is compatible with the standard layout of a DirectX surface in system memory, with no additional padding. For RGB video, the contiguous representation has a pitch equal to the image width in bytes, rounded up to the nearest <strong>DWORD</strong> boundary. For YUV video, the layout of the contiguous representation depends on the YUV format. For planar YUV formats, the Y plane might have a different pitch than the U and V planes.</p><p>If a media buffer supports the <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> interface, the underlying buffer is not guaranteed to have a contiguous representation, because there might be additional padding bytes after each row of pixels. When a buffer is non-contiguous, the <strong>Lock</strong> and <strong>Lock2D</strong> methods have different behaviors:</p><ul> <li> The <strong>Lock2D</strong> method returns a reference to the underlying buffer. The buffer might not be contiguous. </li> <li> The <strong>Lock</strong> method returns a buffer that is guaranteed to be contiguous. If the underlying buffer is not contiguous, the method copies the data into a new buffer, and the <strong>Unlock</strong> method copies it back into the original buffer. </li> </ul><p>Call the <strong>Lock2D</strong> method to access the 2-D buffer in its native format. The native format might not be contiguous. The buffer's <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.Lock(System.Byte[],System.Int32@,System.Int32@)"/></strong> method returns a contiguous representation of the buffer. However, this might require an internal copy from the native format. For 2-D buffers, therefore, you should use the <strong>Lock2D</strong> method and avoid the <strong>Lock</strong> method. Because the <strong>Lock</strong> method might cause up to two buffer copies, the <strong>Lock2D</strong> method is generally more efficient and should be used when possible. To find out if the underlying buffer is contiguous, call <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.IsContiguousFormat_(System.Boolean@)"/></strong>.</p><p>For uncompressed images, the amount of valid data in the buffer is determined by the width, height, and pixel layout of the image. For this reason, if you call <strong>Lock2D</strong> to access the buffer, do not rely on the values returned by <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetCurrentLength(System.Int32@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetMaxLength(System.Int32@)"/></strong>. Similarly, if you modify the data in the buffer, you do not have to call <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.SetCurrentLength(System.Int32)"/></strong> to update the size. Generally, you should avoid mixing calls to <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> and <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> methods on the same media buffer.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer']/*"/>
|
|
<msdn-id>ms699894</msdn-id>
|
|
<unmanaged>IMF2DBuffer</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Buffer2D"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Buffer2D">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Buffer2D"/>. (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.MediaFoundation.Buffer2D.Lock2D(System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gives the caller access to the memory in the buffer.</p>
|
|
</summary>
|
|
<param name="bScanline0Out"><dd> <p>Receives a reference to the first byte of the top row of pixels in the image. The top row is defined as the top row when the image is presented to the viewer, and might not be the first row in memory.</p> </dd></param>
|
|
<param name="lPitchRef"><dd> <p>Receives the surface stride, in bytes. The stride might be negative, indicating that the image is oriented from the bottom up in memory.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>D3DERR_INVALIDCALL</strong></dt> </dl> </td><td> <p>Cannot lock the Direct3D surface.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The buffer cannot be locked at this time.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If <em>p</em> is a reference to the first byte in a row of pixels, <em>p</em> + (*<em>plPitch</em>) points to the first byte in the next row of pixels. A buffer might contain padding after each row of pixels, so the stride might be wider than the width of the image in bytes. Do not access the memory that is reserved for padding bytes, because it might not be read-accessible or write-accessible. For more information, see Image Stride.</p><p>The reference returned in <em>pbScanline0</em> remains valid as long as the caller holds the lock. When you are done accessing the memory, call <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Unlock2D"/></strong> to unlock the buffer. You must call <strong>Unlock2D</strong> once for each call to <strong>Lock2D</strong>. After you unlock the buffer, the reference returned in <em>pbScanline0</em> is no longer valid and should not be used. Generally, it is best to call <strong>Lock2D</strong> only when you need to access the buffer memory, and not earlier.</p><p>The values returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetCurrentLength(System.Int32@)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetMaxLength(System.Int32@)"/></strong> methods do not apply to the buffer that is returned by the <strong>Lock2D</strong> method. For the same reason, you do not need to call <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.SetCurrentLength(System.Int32)"/></strong> after manipulating the data in the buffer returned by the <strong>Lock2D</strong> method.</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.Lock(System.Byte[],System.Int32@,System.Int32@)"/></strong> method fails while the <strong>Lock2D</strong> lock is held, and vice-versa. Applications should use only one of these methods at a time.</p><p>When the underlying buffer is a Direct3D surface, the method fails if the surface is not lockable.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer::Lock2D']/*"/>
|
|
<msdn-id>ms700182</msdn-id>
|
|
<unmanaged>HRESULT IMF2DBuffer::Lock2D([Out, Buffer] unsigned char** ppbScanline0,[Out] int* plPitch)</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer::Lock2D</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D.Unlock2D">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Unlocks a buffer that was previously locked. Call this method once for each call to <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Lock2D(System.Byte[],System.Int32@)"/></strong>.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer::Unlock2D']/*"/>
|
|
<msdn-id>ms697066</msdn-id>
|
|
<unmanaged>HRESULT IMF2DBuffer::Unlock2D()</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer::Unlock2D</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D.GetScanline0AndPitch(System.Byte@,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a reference to the buffer memory and the surface stride.</p>
|
|
</summary>
|
|
<param name="bScanline0Ref"><dd> <p>Receives a reference to the first byte of the top row of pixels in the image.</p> </dd></param>
|
|
<param name="lPitchRef"><dd> <p>Receives the stride, in bytes. For more information, see Image Stride.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Win32.ErrorCode.InvalidFunction"/></strong></dt> </dl> </td><td> <p>You must lock the buffer before calling this method.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Before calling this method, you must lock the buffer by calling <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Lock2D(System.Byte[],System.Int32@)"/></strong>. The reference returned in <em>plPitch</em> is valid only while the buffer remains locked.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer::GetScanline0AndPitch']/*"/>
|
|
<msdn-id>ms694042</msdn-id>
|
|
<unmanaged>HRESULT IMF2DBuffer::GetScanline0AndPitch([Out] unsigned char** pbScanline0,[Out] int* plPitch)</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer::GetScanline0AndPitch</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D.IsContiguousFormat_(System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Queries whether the buffer is contiguous in its native format.</p>
|
|
</summary>
|
|
<param name="fIsContiguousRef"><dd> <p>Receives a Boolean value. The value is <strong>TRUE</strong> if the buffer is contiguous, and <strong><see cref="F:SharpDX.Result.False"/></strong> otherwise.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For a definition of contiguous as it applies to 2-D buffers, see the Remarks section in <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> interface. For non-contiguous buffers, the <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.Lock(System.Byte[],System.Int32@,System.Int32@)"/></strong> method must perform an internal copy.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer::IsContiguousFormat']/*"/>
|
|
<msdn-id>ms701629</msdn-id>
|
|
<unmanaged>HRESULT IMF2DBuffer::IsContiguousFormat([Out] BOOL* pfIsContiguous)</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer::IsContiguousFormat</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D.GetContiguousLength(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of bytes needed to store the contents of the buffer in contiguous format.</p>
|
|
</summary>
|
|
<param name="cbLengthRef"><dd> <p>Receives the number of bytes needed to store the contents of the buffer in contiguous format.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For a definition of contiguous as it applies to 2-D buffers, see the Remarks section in <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer::GetContiguousLength']/*"/>
|
|
<msdn-id>ms696971</msdn-id>
|
|
<unmanaged>HRESULT IMF2DBuffer::GetContiguousLength([Out] unsigned int* pcbLength)</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer::GetContiguousLength</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D.ContiguousCopyTo(System.Byte[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Copies this buffer into the caller's buffer, converting the data to contiguous format.</p>
|
|
</summary>
|
|
<param name="bDestBufferRef"><dd> <p>Pointer to the destination buffer where the data will be copied. The caller allocates the buffer.</p> </dd></param>
|
|
<param name="cbDestBuffer"><dd> <p>Size of the destination buffer, in bytes. To get the required size, call <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.GetContiguousLength(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid size specified in <em>pbDestBuffer</em>.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the original buffer is not contiguous, this method converts the contents into contiguous format during the copy. For a definition of contiguous as it applies to 2-D buffers, see the Remarks section in <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer::ContiguousCopyTo']/*"/>
|
|
<msdn-id>ms696215</msdn-id>
|
|
<unmanaged>HRESULT IMF2DBuffer::ContiguousCopyTo([Out, Buffer] unsigned char* pbDestBuffer,[In] unsigned int cbDestBuffer)</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer::ContiguousCopyTo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D.ContiguousCopyFrom(System.Byte[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Copies data to this buffer from a buffer that has a contiguous format.</p>
|
|
</summary>
|
|
<param name="bSrcBufferRef"><dd> <p>Pointer to the source buffer. The caller allocates the buffer.</p> </dd></param>
|
|
<param name="cbSrcBuffer"><dd> <p>Size of the source buffer, in bytes. To get the maximum size of the buffer, call <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.GetContiguousLength(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method copies the contents of the source buffer into the buffer that is managed by this <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> object. The source buffer must be in contiguous format. While copying, the method converts the contents into the destination buffer's native format, correcting for the buffer's pitch if necessary.</p><p>For a definition of contiguous as it applies to 2-D buffers, see the Remarks section in the <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> interface topic.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer::ContiguousCopyFrom']/*"/>
|
|
<msdn-id>ms700162</msdn-id>
|
|
<unmanaged>HRESULT IMF2DBuffer::ContiguousCopyFrom([In, Buffer] const unsigned char* pbSrcBuffer,[In] unsigned int cbSrcBuffer)</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer::ContiguousCopyFrom</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Buffer2D.IsContiguousFormat">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Queries whether the buffer is contiguous in its native format.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>For a definition of contiguous as it applies to 2-D buffers, see the Remarks section in <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> interface. For non-contiguous buffers, the <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.Lock(System.Byte[],System.Int32@,System.Int32@)"/></strong> method must perform an internal copy.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer::IsContiguousFormat']/*"/>
|
|
<msdn-id>ms701629</msdn-id>
|
|
<unmanaged>IsContiguousFormat</unmanaged>
|
|
<unmanaged-short>IsContiguousFormat</unmanaged-short>
|
|
<unmanaged>HRESULT IMF2DBuffer::IsContiguousFormat([Out] BOOL* pfIsContiguous)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Buffer2D.ContiguousLength">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of bytes needed to store the contents of the buffer in contiguous format.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>For a definition of contiguous as it applies to 2-D buffers, see the Remarks section in <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer::GetContiguousLength']/*"/>
|
|
<msdn-id>ms696971</msdn-id>
|
|
<unmanaged>GetContiguousLength</unmanaged>
|
|
<unmanaged-short>GetContiguousLength</unmanaged-short>
|
|
<unmanaged>HRESULT IMF2DBuffer::GetContiguousLength([Out] unsigned int* pcbLength)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Buffer2D2">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gives the caller access to the memory in the buffer.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>When you are done accessing the memory, call <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Unlock2D"/></strong> to unlock the buffer. You must call <strong>Unlock2D</strong> once for each call to <strong>Lock2DSize</strong>.</p><p>This method is equivalent to the <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Lock2D(System.Byte[],System.Int32@)"/></strong> method. However, <strong>Lock2DSize</strong> is preferred because it enables the caller to validate memory references, and because it supports read-only locks. A buffer is not guaranteed to support the <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D2"/></strong> interface. To access a buffer, you should try the following methods in the order listed:</p><ol> <li><strong><see cref="M:SharpDX.MediaFoundation.Buffer2D2.Lock2DSize(SharpDX.MediaFoundation.Buffer2DLockFlags,System.Byte[],System.Int32@,System.Byte[],System.Int32@)"/></strong></li> <li> <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Lock2D(System.Byte[],System.Int32@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.Lock(System.Byte[],System.Int32@,System.Int32@)"/></strong> </li> </ol><p>The <em>ppbBufferStart</em> and <em>pcbBufferLength</em> parameters receive the bounds of the buffer memory. Use these values to guard against buffer overruns. Use the values of <em>ppbScanline0</em> and <em>plPitch</em> to access the image data. If the image is bottom-up in memory, <em>ppbScanline0</em> will point to the last scan line in memory and <em>plPitch</em> will be negative. For more information, see Image Stride.</p><p>The <em>lockFlags</em> parameter specifies whether the buffer is locked for read-only access, write-only access, or read/write access. </p><ul> <li>If the buffer is already locked for read-only access, it cannot be locked for write access.</li> <li>If the buffer is already locked for write-only access, it cannot be locked for read access.</li> <li>If the buffer is already locked for read/write acess, it can be locked for read or write acess.</li> </ul><p>When possible, use a read-only or write-only lock, and avoid locking the buffer for read/write access. If the buffer represents a DirectX Graphics Infrastructure (DXGI) surface, a read/write lock can cause an extra copy between CPU memory and GPU memory.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer2']/*"/>
|
|
<msdn-id>hh447829</msdn-id>
|
|
<unmanaged>IMF2DBuffer2</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer2</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D2.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Buffer2D2"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D2.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Buffer2D2">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Buffer2D2"/>. (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.MediaFoundation.Buffer2D2.Lock2DSize(SharpDX.MediaFoundation.Buffer2DLockFlags,System.Byte[],System.Int32@,System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gives the caller access to the memory in the buffer.</p>
|
|
</summary>
|
|
<param name="lockFlags"><dd> <p>A member of the <strong><see cref="T:SharpDX.MediaFoundation.Buffer2DLockFlags"/></strong> enumeration that specifies whether to lock the buffer for reading, writing, or both.</p> </dd></param>
|
|
<param name="bScanline0Out"><dd> <p>Receives a reference to the first byte of the top row of pixels in the image. The top row is defined as the top row when the image is presented to the viewer, and might not be the first row in memory. </p> </dd></param>
|
|
<param name="lPitchRef"><dd> <p>Receives the surface stride, in bytes. The stride might be negative, indicating that the image is oriented from the bottom up in memory. </p> </dd></param>
|
|
<param name="bBufferStartOut"><dd> <p>Receives a reference to the start of the accessible buffer in memory.</p> </dd></param>
|
|
<param name="cbBufferLengthRef"><dd> <p>Receives the length of the buffer, in bytes.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Invalid request. The buffer might already be locked with an incompatible locking flag. See Remarks.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When you are done accessing the memory, call <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Unlock2D"/></strong> to unlock the buffer. You must call <strong>Unlock2D</strong> once for each call to <strong>Lock2DSize</strong>.</p><p>This method is equivalent to the <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Lock2D(System.Byte[],System.Int32@)"/></strong> method. However, <strong>Lock2DSize</strong> is preferred because it enables the caller to validate memory references, and because it supports read-only locks. A buffer is not guaranteed to support the <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D2"/></strong> interface. To access a buffer, you should try the following methods in the order listed:</p><ol> <li><strong><see cref="M:SharpDX.MediaFoundation.Buffer2D2.Lock2DSize(SharpDX.MediaFoundation.Buffer2DLockFlags,System.Byte[],System.Int32@,System.Byte[],System.Int32@)"/></strong></li> <li> <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Lock2D(System.Byte[],System.Int32@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.Lock(System.Byte[],System.Int32@,System.Int32@)"/></strong> </li> </ol><p>The <em>ppbBufferStart</em> and <em>pcbBufferLength</em> parameters receive the bounds of the buffer memory. Use these values to guard against buffer overruns. Use the values of <em>ppbScanline0</em> and <em>plPitch</em> to access the image data. If the image is bottom-up in memory, <em>ppbScanline0</em> will point to the last scan line in memory and <em>plPitch</em> will be negative. For more information, see Image Stride.</p><p>The <em>lockFlags</em> parameter specifies whether the buffer is locked for read-only access, write-only access, or read/write access. </p><ul> <li>If the buffer is already locked for read-only access, it cannot be locked for write access.</li> <li>If the buffer is already locked for write-only access, it cannot be locked for read access.</li> <li>If the buffer is already locked for read/write acess, it can be locked for read or write acess.</li> </ul><p>When possible, use a read-only or write-only lock, and avoid locking the buffer for read/write access. If the buffer represents a DirectX Graphics Infrastructure (DXGI) surface, a read/write lock can cause an extra copy between CPU memory and GPU memory.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer2::Lock2DSize']/*"/>
|
|
<msdn-id>hh447829</msdn-id>
|
|
<unmanaged>HRESULT IMF2DBuffer2::Lock2DSize([In] MF2DBuffer_LockFlags lockFlags,[Out, Buffer] unsigned char** ppbScanline0,[Out] int* plPitch,[Out, Buffer] unsigned char** ppbBufferStart,[Out] unsigned int* pcbBufferLength)</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer2::Lock2DSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Buffer2D2.Copy2DTo(SharpDX.MediaFoundation.Buffer2D2)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Copies the buffer to another 2D buffer object.</p>
|
|
</summary>
|
|
<param name="destBufferRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D2"/></strong> interface of the destination buffer.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The destination buffer must be at least as large as the source buffer.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMF2DBuffer2::Copy2DTo']/*"/>
|
|
<msdn-id>hh447828</msdn-id>
|
|
<unmanaged>HRESULT IMF2DBuffer2::Copy2DTo([In] IMF2DBuffer2* pDestBuffer)</unmanaged>
|
|
<unmanaged-short>IMF2DBuffer2::Copy2DTo</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ByteStream">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Represents a byte stream from some data source, which might be a local file, a network file, or some other source. The <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface supports the typical stream operations, such as reading, writing, and seeking. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> The following functions return <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> references for local files: </p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.BeginCreateFile(SharpDX.MediaFoundation.FileAccessmode,SharpDX.MediaFoundation.FileOpenmode,SharpDX.MediaFoundation.FileFlags,System.String,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.ComObject@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateFile(SharpDX.MediaFoundation.FileAccessmode,SharpDX.MediaFoundation.FileOpenmode,SharpDX.MediaFoundation.FileFlags,System.String,SharpDX.MediaFoundation.ByteStream@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTempFile(SharpDX.MediaFoundation.FileAccessmode,SharpDX.MediaFoundation.FileOpenmode,SharpDX.MediaFoundation.FileFlags,SharpDX.MediaFoundation.ByteStream@)"/></strong> </li> </ul><p> A byte stream for a media souce can be opened with read access. A byte stream for an archive media sink should be opened with both read and write access. (Read access may be required, because the archive sink might need to read portions of the file as it writes.) </p><p>Some implementations of this interface also expose one or more of the following interfaces:</p><ul> <li> <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> </li> <li> <strong><see cref="T:SharpDX.MediaFoundation.ByteStreamBuffering"/></strong> </li> <li> <strong><see cref="T:SharpDX.MediaFoundation.ByteStreamCacheControl"/></strong> </li> <li> <strong><see cref="T:SharpDX.MediaFoundation.ServiceProvider"/></strong> </li> <li> <strong><see cref="T:SharpDX.MediaFoundation.MediaEventGenerator"/></strong> </li> </ul><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream']/*"/>
|
|
<msdn-id>ms698720</msdn-id>
|
|
<unmanaged>IMFByteStream</unmanaged>
|
|
<unmanaged-short>IMFByteStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ByteStream"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ByteStream">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ByteStream"/>. (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.MediaFoundation.ByteStream.GetCapabilities(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves the characteristics of the byte stream. </p>
|
|
</summary>
|
|
<param name="dwCapabilitiesRef"><dd> <p>Receives a bitwise <strong>OR</strong> of zero or more flags. The following flags are defined.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>MFBYTESTREAM_IS_READABLE</strong></dt> <dt>0x00000001</dt> </dl> </td><td> <p> The byte stream can be read. </p> </td></tr> <tr><td><dl> <dt><strong>MFBYTESTREAM_IS_WRITABLE</strong></dt> <dt>0x00000002</dt> </dl> </td><td> <p> The byte stream can be written to. </p> </td></tr> <tr><td><dl> <dt><strong>MFBYTESTREAM_IS_SEEKABLE</strong></dt> <dt>0x00000004</dt> </dl> </td><td> <p> The byte stream can be seeked. </p> </td></tr> <tr><td><dl> <dt><strong>MFBYTESTREAM_IS_REMOTE</strong></dt> <dt>0x00000008</dt> </dl> </td><td> <p> The byte stream is from a remote source, such as a network. </p> </td></tr> <tr><td><dl> <dt><strong>MFBYTESTREAM_IS_DIRECTORY</strong></dt> <dt>0x00000080</dt> </dl> </td><td> <p> The byte stream represents a file directory. </p> </td></tr> <tr><td><dl> <dt><strong>MFBYTESTREAM_HAS_SLOW_SEEK</strong></dt> <dt>0x00000100</dt> </dl> </td><td> <p> Seeking within this stream might be slow. For example, the byte stream might download from a network.</p> </td></tr> <tr><td><dl> <dt><strong>MFBYTESTREAM_IS_PARTIALLY_DOWNLOADED</strong></dt> <dt>0x00000200</dt> </dl> </td><td> <p>The byte stream is currently downloading data to a local cache. Read operations on the byte stream might take longer until the data is completely downloaded.</p> <p>This flag is cleared after all of the data has been downloaded.</p> <p>If the <strong>MFBYTESTREAM_HAS_SLOW_SEEK</strong> flag is also set, it means the byte stream must download the entire file sequentially. Otherwise, the byte stream can respond to seek requests by restarting the download from a new point in the stream.</p> </td></tr> <tr><td><dl> <dt><strong>MFBYTESTREAM_SHARE_WRITE</strong></dt> <dt>0x00000400</dt> </dl> </td><td> <p>Another thread or process can open this byte stream for writing. If this flag is present, the length of thebyte stream could change while it is being read. </p> <p>This flag can affect the behavior of byte-stream handlers. For more information, see <see cref="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.HandlerAcceptsShareWrite"/>.</p> <p><strong>Note</strong>??Requires Windows?7 or later.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::GetCapabilities']/*"/>
|
|
<msdn-id>ms698962</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::GetCapabilities([Out] unsigned int* pdwCapabilities)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::GetCapabilities</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.GetLength(System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves the length of the stream. </p>
|
|
</summary>
|
|
<param name="qwLengthRef"><dd> <p> Receives the length of the stream, in bytes. If the length is unknown, this value is -1. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::GetLength']/*"/>
|
|
<msdn-id>ms698941</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::GetLength([Out] unsigned longlong* pqwLength)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::GetLength</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.SetLength(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the length of the stream.</p>
|
|
</summary>
|
|
<param name="qwLength"><dd> <p> Length of the stream in bytes. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::SetLength']/*"/>
|
|
<msdn-id>ms697225</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::SetLength([In] unsigned longlong qwLength)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::SetLength</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.GetCurrentPosition(System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves the current read or write position in the stream. </p>
|
|
</summary>
|
|
<param name="qwPositionRef"><dd> <p> Receives the current position, in bytes. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> The methods that update the current position are <strong>Read</strong>, <strong>BeginRead</strong>, <strong>Write</strong>, <strong>BeginWrite</strong>, <strong>SetCurrentPosition</strong>, and <strong>Seek</strong>. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::GetCurrentPosition']/*"/>
|
|
<msdn-id>ms704059</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::GetCurrentPosition([Out] unsigned longlong* pqwPosition)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::GetCurrentPosition</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.SetCurrentPosition(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the current read or write position.</p>
|
|
</summary>
|
|
<param name="qwPosition"><dd> <p>New position in the stream, as a byte offset from the start of the stream.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> Invalid argument. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If the new position is larger than the length of the stream, the method returns E_INVALIDARG. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::SetCurrentPosition']/*"/>
|
|
<msdn-id>ms695238</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::SetCurrentPosition([In] unsigned longlong qwPosition)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::SetCurrentPosition</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.IsEndOfStream_(System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Queries whether the current position has reached the end of the stream.</p>
|
|
</summary>
|
|
<param name="fEndOfStreamRef"><dd> <p> Receives the value <strong>TRUE</strong> if the end of the stream has been reached, or <strong><see cref="F:SharpDX.Result.False"/></strong> otherwise. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::IsEndOfStream']/*"/>
|
|
<msdn-id>ms697369</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::IsEndOfStream([Out] BOOL* pfEndOfStream)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::IsEndOfStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.Read(System.Byte[],System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Reads data from the stream. </p>
|
|
</summary>
|
|
<param name="bRef"><dd> <p> Pointer to a buffer that receives the data. The caller must allocate the buffer. </p> </dd></param>
|
|
<param name="cb"><dd> <p> Size of the buffer in bytes. </p> </dd></param>
|
|
<param name="cbReadRef"><dd> <p> Receives the number of bytes that are copied into the buffer. This parameter cannot be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This method reads at most <em>cb</em> bytes from the current position in the stream and copies them into the buffer provided by the caller. The number of bytes that were read is returned in the <em>pcbRead</em> parameter. The method does not return an error code on reaching the end of the file, so the application should check the value in <em>pcbRead</em> after the method returns. </p><p> This method is synchronous. It blocks until the read operation completes. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::Read']/*"/>
|
|
<msdn-id>ms698913</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::Read([Out, Buffer] unsigned char* pb,[In] unsigned int cb,[Out] unsigned int* pcbRead)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::Read</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.BeginRead(System.Byte[],System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Begins an asynchronous read operation from the stream. </p>
|
|
</summary>
|
|
<param name="bRef"><dd> <p> Pointer to a buffer that receives the data. The caller must allocate the buffer. </p> </dd></param>
|
|
<param name="cb"><dd> <p> Size of the buffer in bytes. </p> </dd></param>
|
|
<param name="callbackRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface. </p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> When all of the data has been read into the buffer, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.ByteStream.EndRead(SharpDX.MediaFoundation.AsyncResult,System.Int32@)"/></strong> to complete the asynchronous request. </p><p> Do not read from, write to, free, or reallocate the buffer while an asynchronous read is pending. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::BeginRead']/*"/>
|
|
<msdn-id>ms704810</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::BeginRead([Out, Buffer] unsigned char* pb,[In] unsigned int cb,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::BeginRead</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.EndRead(SharpDX.MediaFoundation.AsyncResult,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Completes an asynchronous read operation. </p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. </p> </dd></param>
|
|
<param name="cbReadRef"><dd> <p> Receives the number of bytes that were read. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> Call this method after the <strong><see cref="M:SharpDX.MediaFoundation.ByteStream.BeginRead(System.Byte[],System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::EndRead']/*"/>
|
|
<msdn-id>ms704042</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::EndRead([In] IMFAsyncResult* pResult,[Out] unsigned int* pcbRead)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::EndRead</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.Write(System.Byte[],System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Writes data to the stream.</p>
|
|
</summary>
|
|
<param name="bRef"><dd> <p> Pointer to a buffer that contains the data to write. </p> </dd></param>
|
|
<param name="cb"><dd> <p> Size of the buffer in bytes. </p> </dd></param>
|
|
<param name="cbWrittenRef"><dd> <p> Receives the number of bytes that are written. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This method writes the contents of the <em>pb</em> buffer to the stream, starting at the current stream position. The number of bytes that were written is returned in the <em>pcbWritten</em> parameter. </p><p> This method is synchronous. It blocks until the write operation completes. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::Write']/*"/>
|
|
<msdn-id>ms703843</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::Write([In, Buffer] const unsigned char* pb,[In] unsigned int cb,[Out] unsigned int* pcbWritten)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::Write</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.BeginWrite(System.Byte[],System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Begins an asynchronous write operation to the stream. </p>
|
|
</summary>
|
|
<param name="bRef"><dd> <p> Pointer to a buffer containing the data to write. </p> </dd></param>
|
|
<param name="cb"><dd> <p> Size of the buffer in bytes. </p> </dd></param>
|
|
<param name="callbackRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface. </p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> When all of the data has been written to the stream, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.ByteStream.EndWrite(SharpDX.MediaFoundation.AsyncResult,System.Int32@)"/></strong> to complete the asynchronous request. </p><p> Do not reallocate, free, or write to the buffer while an asynchronous write is still pending. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::BeginWrite']/*"/>
|
|
<msdn-id>ms694005</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::BeginWrite([In, Buffer] const unsigned char* pb,[In] unsigned int cb,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::BeginWrite</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.EndWrite(SharpDX.MediaFoundation.AsyncResult,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Completes an asynchronous write operation.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p> </dd></param>
|
|
<param name="cbWrittenRef"><dd> <p> Receives the number of bytes that were written. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> Call this method when the <strong><see cref="M:SharpDX.MediaFoundation.ByteStream.BeginWrite(System.Byte[],System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::EndWrite']/*"/>
|
|
<msdn-id>ms703863</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::EndWrite([In] IMFAsyncResult* pResult,[Out] unsigned int* pcbWritten)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::EndWrite</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.Seek(SharpDX.MediaFoundation.BytestreamSeekOrigin,System.Int64,System.Int32,System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Moves the current position in the stream by a specified offset.</p>
|
|
</summary>
|
|
<param name="seekOrigin"><dd> <p> Specifies the origin of the seek as a member of the <strong><see cref="T:SharpDX.MediaFoundation.BytestreamSeekOrigin"/></strong> enumeration. The offset is calculated relative to this position. </p> </dd></param>
|
|
<param name="llSeekOffset"><dd> <p> Specifies the new position, as a byte offset from the seek origin. </p> </dd></param>
|
|
<param name="dwSeekFlags"><dd> <p> Specifies zero or more flags. The following flags are defined. </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>MFBYTESTREAM_SEEK_FLAG_CANCEL_PENDING_IO</strong></dt> </dl> </td><td> <p> All pending I/O requests are canceled after the seek request completes successfully. </p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="qwCurrentPositionRef"><dd> <p> Receives the new position after the seek. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::Seek']/*"/>
|
|
<msdn-id>ms697053</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::Seek([In] MFBYTESTREAM_SEEK_ORIGIN SeekOrigin,[In] longlong llSeekOffset,[In] unsigned int dwSeekFlags,[Out] unsigned longlong* pqwCurrentPosition)</unmanaged>
|
|
<unmanaged-short>IMFByteStream::Seek</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.Flush">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Clears any internal buffers used by the stream. If you are writing to the stream, the buffered data is written to the underlying file or device. </p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> If the byte stream is read-only, this method has no effect.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::Flush']/*"/>
|
|
<msdn-id>ms694833</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::Flush()</unmanaged>
|
|
<unmanaged-short>IMFByteStream::Flush</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStream.Close">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Closes the stream and releases any resources associated with the stream, such as sockets or file handles. This method also cancels any pending asynchronous I/O requests. </p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::Close']/*"/>
|
|
<msdn-id>ms703909</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStream::Close()</unmanaged>
|
|
<unmanaged-short>IMFByteStream::Close</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ByteStream.Capabilities">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves the characteristics of the byte stream. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::GetCapabilities']/*"/>
|
|
<msdn-id>ms698962</msdn-id>
|
|
<unmanaged>GetCapabilities</unmanaged>
|
|
<unmanaged-short>GetCapabilities</unmanaged-short>
|
|
<unmanaged>HRESULT IMFByteStream::GetCapabilities([Out] unsigned int* pdwCapabilities)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ByteStream.Length">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves the length of the stream. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::GetLength']/*"/>
|
|
<msdn-id>ms698941</msdn-id>
|
|
<unmanaged>GetLength</unmanaged>
|
|
<unmanaged-short>GetLength</unmanaged-short>
|
|
<unmanaged>HRESULT IMFByteStream::GetLength([Out] unsigned longlong* pqwLength)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ByteStream.CurrentPosition">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves the current read or write position in the stream. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> The methods that update the current position are <strong>Read</strong>, <strong>BeginRead</strong>, <strong>Write</strong>, <strong>BeginWrite</strong>, <strong>SetCurrentPosition</strong>, and <strong>Seek</strong>. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::GetCurrentPosition']/*"/>
|
|
<msdn-id>ms704059</msdn-id>
|
|
<unmanaged>GetCurrentPosition</unmanaged>
|
|
<unmanaged-short>GetCurrentPosition</unmanaged-short>
|
|
<unmanaged>HRESULT IMFByteStream::GetCurrentPosition([Out] unsigned longlong* pqwPosition)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ByteStream.IsEndOfStream">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Queries whether the current position has reached the end of the stream.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStream::IsEndOfStream']/*"/>
|
|
<msdn-id>ms697369</msdn-id>
|
|
<unmanaged>IsEndOfStream</unmanaged>
|
|
<unmanaged-short>IsEndOfStream</unmanaged-short>
|
|
<unmanaged>HRESULT IMFByteStream::IsEndOfStream([Out] BOOL* pfEndOfStream)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ByteStreamBuffering">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Controls how a byte stream buffers data from a network. </p><p>To get a reference to this interface, call <strong>QueryInterface</strong> on the byte stream object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> If a byte stream implements this interface, a media source can use it to control how the byte stream buffers data. This interface is designed for byte streams that read data from a network. </p><p> A byte stream that implements this interface should also implement the <strong><see cref="T:SharpDX.MediaFoundation.MediaEventGenerator"/></strong> interface. When the byte stream starts buffering, it sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStarted"/> event. When it stops buffering, it sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStopped"/> event. </p><p> The byte stream must send a matching <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStopped"/> event for every <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStarted"/> event. The byte stream must not send <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStarted"/> events unless the media source has enabled buffering by calling <strong>EnableBuffering</strong> with the value <strong>TRUE</strong>. </p><p> After the byte stream sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStarted"/> event, it should send <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStopped"/> if any of the following occur: </p><ul> <li> The byte stream finishes buffering data. </li> <li> The byte stream reaches the end of the stream. </li> <li> The media source calls <strong>EnableBuffering</strong> with the value <strong><see cref="F:SharpDX.Result.False"/></strong>. </li> <li> The media source calls <strong>StopBuffering</strong>. </li> </ul><p> The byte stream should not send any more buffering events after it reaches the end of the file. </p><p> If buffering is disabled, the byte stream does not send any buffering events. Internally, however, it might still buffer data while it waits for I/O requests to complete. Therefore, <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> methods might take an indefinite length of time to complete. </p><p> If the byte stream is buffering data internally and the media source calls <strong>EnableBuffering</strong> with the value <strong>TRUE</strong>, the byte stream can send <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStarted"/> immediately. </p><p> After the presentation has started, the media source should forward and <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStarted"/> and <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStopped"/> events that it receives while started. The Media Session will pause the presentation clock while buffering is progress and restart the presentation clock when buffering completes. The media source should only forward these events while the presentation is playing. The purpose of sending these events to the Media Session is to pause the presentation time while the source buffers data. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamBuffering']/*"/>
|
|
<msdn-id>aa372548</msdn-id>
|
|
<unmanaged>IMFByteStreamBuffering</unmanaged>
|
|
<unmanaged-short>IMFByteStreamBuffering</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamBuffering.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ByteStreamBuffering"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamBuffering.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ByteStreamBuffering">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ByteStreamBuffering"/>. (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.MediaFoundation.ByteStreamBuffering.SetBufferingParams(SharpDX.MediaFoundation.BytestreamBufferingParams@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the buffering parameters.</p>
|
|
</summary>
|
|
<param name="paramsRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.BytestreamBufferingParams"/></strong> structure that contains the buffering parameters. The byte stream uses this information to calculate how much data to buffer from the network.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamBuffering::SetBufferingParams']/*"/>
|
|
<msdn-id>aa366520</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamBuffering::SetBufferingParams([In] MFBYTESTREAM_BUFFERING_PARAMS* pParams)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamBuffering::SetBufferingParams</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamBuffering.EnableBuffering(System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Enables or disables buffering.</p>
|
|
</summary>
|
|
<param name="fEnable"><dd> <p>Specifies whether the byte stream buffers data. If <strong>TRUE</strong>, buffering is enabled. If <strong><see cref="F:SharpDX.Result.False"/></strong>, buffering is disabled.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Before calling this method, call <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamBuffering.SetBufferingParams(SharpDX.MediaFoundation.BytestreamBufferingParams@)"/></strong> to set the buffering parameters on the byte stream.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamBuffering::EnableBuffering']/*"/>
|
|
<msdn-id>aa369933</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamBuffering::EnableBuffering([In] BOOL fEnable)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamBuffering::EnableBuffering</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamBuffering.StopBuffering">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Stops any buffering that is in progress.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The byte stream successfully stopped buffering.</p> </td></tr> <tr><td> <dl> <dt><strong>S_FALSE</strong></dt> </dl> </td><td> <p>No buffering was in progress.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the byte stream is currently buffering data, it stops and sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStopped"/> event. If the byte stream is not currently buffering, this method has no effect.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamBuffering::StopBuffering']/*"/>
|
|
<msdn-id>aa375256</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamBuffering::StopBuffering()</unmanaged>
|
|
<unmanaged-short>IMFByteStreamBuffering::StopBuffering</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ByteStreamBuffering.BufferingParams">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the buffering parameters.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamBuffering::SetBufferingParams']/*"/>
|
|
<msdn-id>aa366520</msdn-id>
|
|
<unmanaged>SetBufferingParams</unmanaged>
|
|
<unmanaged-short>SetBufferingParams</unmanaged-short>
|
|
<unmanaged>HRESULT IMFByteStreamBuffering::SetBufferingParams([In] MFBYTESTREAM_BUFFERING_PARAMS* pParams)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ByteStreamCacheControl">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Stops the background transfer of data to the local cache.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The byte stream resumes transferring data to the cache if the application does one of the following:</p><ul> <li>Reads data from the byte stream.</li> <li>Calls the byte stream's <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamBuffering.EnableBuffering(System.Boolean)"/></strong> method.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamCacheControl']/*"/>
|
|
<msdn-id>dd368786</msdn-id>
|
|
<unmanaged>IMFByteStreamCacheControl</unmanaged>
|
|
<unmanaged-short>IMFByteStreamCacheControl</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamCacheControl.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ByteStreamCacheControl"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamCacheControl.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ByteStreamCacheControl">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ByteStreamCacheControl"/>. (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.MediaFoundation.ByteStreamCacheControl.StopBackgroundTransfer">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Stops the background transfer of data to the local cache.</p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The byte stream resumes transferring data to the cache if the application does one of the following:</p><ul> <li>Reads data from the byte stream.</li> <li>Calls the byte stream's <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamBuffering.EnableBuffering(System.Boolean)"/></strong> method.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamCacheControl::StopBackgroundTransfer']/*"/>
|
|
<msdn-id>dd368786</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamCacheControl::StopBackgroundTransfer()</unmanaged>
|
|
<unmanaged-short>IMFByteStreamCacheControl::StopBackgroundTransfer</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ByteStreamCacheControl2">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Queries whether background transfer is active.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Background transfer might stop because the cache limit was reached (see <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamCacheControl2.SetCacheLimit(System.Int64)"/></strong>) or because the <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamCacheControl.StopBackgroundTransfer"/></strong> method was called.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamCacheControl2']/*"/>
|
|
<msdn-id>hh447832</msdn-id>
|
|
<unmanaged>IMFByteStreamCacheControl2</unmanaged>
|
|
<unmanaged-short>IMFByteStreamCacheControl2</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamCacheControl2.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ByteStreamCacheControl2"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamCacheControl2.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ByteStreamCacheControl2">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ByteStreamCacheControl2"/>. (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.MediaFoundation.ByteStreamCacheControl2.GetByteRanges(System.Int32@,SharpDX.MediaFoundation.ByteStreamCacheRange[])">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Gets the ranges of bytes that are currently stored in the cache.</p>
|
|
</summary>
|
|
<param name="cRangesRef"><dd> <p>Receives the number of ranges returned in the <em>ppRanges</em> array.</p> </dd></param>
|
|
<param name="rangesOut"><dd> <p>Receives an array of <strong><see cref="T:SharpDX.MediaFoundation.ByteStreamCacheRange"/></strong> structures. Each structure specifies a range of bytes stored in the cache. The caller must free the array by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamCacheControl2::GetByteRanges']/*"/>
|
|
<msdn-id>hh447831</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamCacheControl2::GetByteRanges([Out] unsigned int* pcRanges,[Out, Buffer, Optional] MF_BYTE_STREAM_CACHE_RANGE** ppRanges)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamCacheControl2::GetByteRanges</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamCacheControl2.SetCacheLimit(System.Int64)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Limits the cache size.</p>
|
|
</summary>
|
|
<param name="qwBytes"><dd> <p>The maximum number of bytes to store in the cache, or <strong>ULONGLONG_MAX </strong> for no limit. The default value is no limit.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamCacheControl2::SetCacheLimit']/*"/>
|
|
<msdn-id>hh447833</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamCacheControl2::SetCacheLimit([In] unsigned longlong qwBytes)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamCacheControl2::SetCacheLimit</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamCacheControl2.IsBackgroundTransferActive_(System.Boolean@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Queries whether background transfer is active.</p>
|
|
</summary>
|
|
<param name="fActiveRef"><dd> <p>Receives the value <strong>TRUE</strong> if background transfer is currently active, or <strong><see cref="F:SharpDX.Result.False"/></strong> otherwise.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Background transfer might stop because the cache limit was reached (see <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamCacheControl2.SetCacheLimit(System.Int64)"/></strong>) or because the <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamCacheControl.StopBackgroundTransfer"/></strong> method was called.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamCacheControl2::IsBackgroundTransferActive']/*"/>
|
|
<msdn-id>hh447832</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamCacheControl2::IsBackgroundTransferActive([Out] BOOL* pfActive)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamCacheControl2::IsBackgroundTransferActive</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ByteStreamCacheControl2.CacheLimit">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Limits the cache size.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamCacheControl2::SetCacheLimit']/*"/>
|
|
<msdn-id>hh447833</msdn-id>
|
|
<unmanaged>SetCacheLimit</unmanaged>
|
|
<unmanaged-short>SetCacheLimit</unmanaged-short>
|
|
<unmanaged>HRESULT IMFByteStreamCacheControl2::SetCacheLimit([In] unsigned longlong qwBytes)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ByteStreamCacheControl2.IsBackgroundTransferActive">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Queries whether background transfer is active.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Background transfer might stop because the cache limit was reached (see <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamCacheControl2.SetCacheLimit(System.Int64)"/></strong>) or because the <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamCacheControl.StopBackgroundTransfer"/></strong> method was called.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamCacheControl2::IsBackgroundTransferActive']/*"/>
|
|
<msdn-id>hh447832</msdn-id>
|
|
<unmanaged>IsBackgroundTransferActive</unmanaged>
|
|
<unmanaged-short>IsBackgroundTransferActive</unmanaged-short>
|
|
<unmanaged>HRESULT IMFByteStreamCacheControl2::IsBackgroundTransferActive([Out] BOOL* pfActive)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ByteStreamHandler">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates a media source from a byte stream. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Applications do not use this interface directly. This interface is exposed by byte-stream handlers, which are used by the source resolver. When the byte-stream handler is given a byte stream, it parses the stream and creates a media source. Byte-stream handlers are registered by file name extension or MIME type.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamHandler']/*"/>
|
|
<msdn-id>ms699886</msdn-id>
|
|
<unmanaged>IMFByteStreamHandler</unmanaged>
|
|
<unmanaged-short>IMFByteStreamHandler</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamHandler.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ByteStreamHandler"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamHandler.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ByteStreamHandler">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ByteStreamHandler"/>. (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.MediaFoundation.ByteStreamHandler.BeginCreateObject(SharpDX.MediaFoundation.ByteStream,System.String,System.Int32,SharpDX.ComObject,SharpDX.ComObject@,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Begins an asynchronous request to create a media source from a byte stream.</p>
|
|
</summary>
|
|
<param name="byteStreamRef"><dd> <p>Pointer to the byte stream's <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface.</p> </dd></param>
|
|
<param name="wszURLRef"><dd> <p>String that contains the original URL of the byte stream. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="dwFlags"><dd> <p>Bitwise OR of zero or more flags. See <strong>Source Resolver Flags</strong>.</p> </dd></param>
|
|
<param name="propsRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a property store. The byte-stream handler can use this property store to configure the object. This parameter can be <strong><c>null</c></strong>. For more information, see Configuring a Media Source.</p> </dd></param>
|
|
<param name="iUnknownCancelCookieOut"><dd> <p>Receives an <strong><see cref="T:SharpDX.ComObject"/></strong> reference or the value <strong><c>null</c></strong>. If the value is not <strong><c>null</c></strong>, you can cancel the asynchronous operation by passing this reference to the <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamHandler.CancelObjectCreation(SharpDX.ComObject)"/></strong> method. The caller must release the interface. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface.</p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CANNOT_PARSE_BYTESTREAM</strong></dt> </dl> </td><td> <p>Unable to parse the byte stream.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <em>dwFlags</em> parameter must contain the <see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/> flag and should not contain the <see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/> flag.</p><p>The byte-stream handler is responsible for parsing the stream and validating the contents. If the stream is not valid or the byte stream handler cannot parse the stream, the handler should return a failure code. The byte stream is not guaranteed to match the type of stream that the byte handler is designed to parse.</p><p>If the <em>pwszURL</em> parameter is not <strong><c>null</c></strong>, the byte-stream handler might use the URL during the resolution process. (For example, it might use the file name extension, if present.) Also, the byte stream might contain the <strong><see cref="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.ContentType"/></strong> attribute, specifying the MIME type.</p><p>When the operation completes, the byte-stream handler calls the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. The <strong>Invoke</strong> method should call <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamHandler.EndCreateObject(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong> to get a reference to the media source.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamHandler::BeginCreateObject']/*"/>
|
|
<msdn-id>ms696214</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamHandler::BeginCreateObject([In] IMFByteStream* pByteStream,[In] const wchar_t* pwszURL,[In] unsigned int dwFlags,[In] IPropertyStore* pProps,[Out, Optional] IUnknown** ppIUnknownCancelCookie,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamHandler::BeginCreateObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamHandler.EndCreateObject(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Completes an asynchronous request to create a media source.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong>Invoke</strong> method.</p> </dd></param>
|
|
<param name="objectTypeRef"><dd> <p>Receives a member of the <strong><see cref="T:SharpDX.MediaFoundation.ObjectType"/></strong> enumeration, specifying the type of object that was created.</p> </dd></param>
|
|
<param name="objectOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the media source. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_ABORT</strong></dt> </dl> </td><td> <p>The operation was canceled. See <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamHandler.CancelObjectCreation(SharpDX.ComObject)"/></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CANNOT_PARSE_BYTESTREAM</strong></dt> </dl> </td><td> <p>Unable to parse the byte stream.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method from inside the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamHandler::EndCreateObject']/*"/>
|
|
<msdn-id>ms700217</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamHandler::EndCreateObject([In] IMFAsyncResult* pResult,[Out] MF_OBJECT_TYPE* pObjectType,[Out] IUnknown** ppObject)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamHandler::EndCreateObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamHandler.CancelObjectCreation(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Cancels the current request to create a media source.</p>
|
|
</summary>
|
|
<param name="iUnknownCancelCookieRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface that was returned in the <em>ppIUnknownCancelCookie</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamHandler.BeginCreateObject(SharpDX.MediaFoundation.ByteStream,System.String,System.Int32,SharpDX.ComObject,SharpDX.ComObject@,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You can use this method to cancel a previous call to <strong>BeginCreateObject</strong>. Because that method is asynchronous, however, it might be completed before the operation can be canceled. Therefore, your callback might still be invoked after you call this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamHandler::CancelObjectCreation']/*"/>
|
|
<msdn-id>ms701576</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamHandler::CancelObjectCreation([In] IUnknown* pIUnknownCancelCookie)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamHandler::CancelObjectCreation</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamHandler.GetMaxNumberOfBytesRequiredForResolution(System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the maximum number of bytes needed to create the media source or determine that the byte stream handler cannot parse this stream.</p>
|
|
</summary>
|
|
<param name="qwBytesRef"><dd> <p>Receives the maximum number of bytes that are required.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamHandler::GetMaxNumberOfBytesRequiredForResolution']/*"/>
|
|
<msdn-id>ms704770</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamHandler::GetMaxNumberOfBytesRequiredForResolution([Out] unsigned longlong* pqwBytes)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamHandler::GetMaxNumberOfBytesRequiredForResolution</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ByteStreamHandler.MaxNumberOfBytesRequiredForResolution">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the maximum number of bytes needed to create the media source or determine that the byte stream handler cannot parse this stream.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamHandler::GetMaxNumberOfBytesRequiredForResolution']/*"/>
|
|
<msdn-id>ms704770</msdn-id>
|
|
<unmanaged>GetMaxNumberOfBytesRequiredForResolution</unmanaged>
|
|
<unmanaged-short>GetMaxNumberOfBytesRequiredForResolution</unmanaged-short>
|
|
<unmanaged>HRESULT IMFByteStreamHandler::GetMaxNumberOfBytesRequiredForResolution([Out] unsigned longlong* pqwBytes)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ByteStreamProxyClassFactory">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Creates a proxy to a byte stream. The proxy enables a media source to read from a byte stream in another process.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamProxyClassFactory']/*"/>
|
|
<msdn-id>hh447835</msdn-id>
|
|
<unmanaged>IMFByteStreamProxyClassFactory</unmanaged>
|
|
<unmanaged-short>IMFByteStreamProxyClassFactory</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamProxyClassFactory.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ByteStreamProxyClassFactory"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamProxyClassFactory.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ByteStreamProxyClassFactory">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ByteStreamProxyClassFactory"/>. (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.MediaFoundation.ByteStreamProxyClassFactory.CreateByteStreamProxy(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaAttributes,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Creates a proxy to a byte stream. The proxy enables a media source to read from a byte stream in another process.</p>
|
|
</summary>
|
|
<param name="byteStreamRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of the byte stream to proxy.</p> </dd></param>
|
|
<param name="attributesRef"><dd> <p>Reserved. Set to <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="riid"><dd> <p>The interface identifer (IID) of the interface being requested.</p> </dd></param>
|
|
<param name="vObjectOut"><dd> <p>Receives a reference to the interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamProxyClassFactory::CreateByteStreamProxy']/*"/>
|
|
<msdn-id>hh447835</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamProxyClassFactory::CreateByteStreamProxy([In, Optional] IMFByteStream* pByteStream,[In, Optional] IMFAttributes* pAttributes,[In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamProxyClassFactory::CreateByteStreamProxy</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ByteStreamTimeSeek">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Gets the result of a time-based seek.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method returns the server response from a previous time-based seek. </p><p><strong>Note</strong>??This method normally cannot be invoked until some data is read from the byte stream, because the <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamTimeSeek.TimeSeek(System.Int64)"/></strong> method does not send a server request immediately.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamTimeSeek']/*"/>
|
|
<msdn-id>hh447837</msdn-id>
|
|
<unmanaged>IMFByteStreamTimeSeek</unmanaged>
|
|
<unmanaged-short>IMFByteStreamTimeSeek</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamTimeSeek.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ByteStreamTimeSeek"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamTimeSeek.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ByteStreamTimeSeek">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ByteStreamTimeSeek"/>. (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.MediaFoundation.ByteStreamTimeSeek.IsTimeSeekSupported_(System.Boolean@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Queries whether the byte stream supports time-based seeking.</p>
|
|
</summary>
|
|
<param name="fTimeSeekIsSupportedRef"><dd> <p>Receives the value <strong>TRUE</strong> if the byte stream supports time-based seeking, or <strong><see cref="F:SharpDX.Result.False"/></strong> otherwise.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamTimeSeek::IsTimeSeekSupported']/*"/>
|
|
<msdn-id>hh447838</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamTimeSeek::IsTimeSeekSupported([Out] BOOL* pfTimeSeekIsSupported)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamTimeSeek::IsTimeSeekSupported</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamTimeSeek.TimeSeek(System.Int64)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Seeks to a new position in the byte stream.</p>
|
|
</summary>
|
|
<param name="qwTimePosition"><dd> <p>The new position, in 100-nanosecond units.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>If the byte stream reads from a server, it might cache the seek request until the next read request. Therefore, the byte stream might not send a request to the server immediately.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamTimeSeek::TimeSeek']/*"/>
|
|
<msdn-id>hh447839</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamTimeSeek::TimeSeek([In] unsigned longlong qwTimePosition)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamTimeSeek::TimeSeek</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ByteStreamTimeSeek.GetTimeSeekResult(System.Int64@,System.Int64@,System.Int64@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Gets the result of a time-based seek.</p>
|
|
</summary>
|
|
<param name="qwStartTimeRef"><dd> <p>Receives the new position after the seek, in 100-nanosecond units.</p> </dd></param>
|
|
<param name="qwStopTimeRef"><dd> <p>Receives the stop time, in 100-nanosecond units. If the stop time is unknown, the value is zero.</p> </dd></param>
|
|
<param name="qwDurationRef"><dd> <p>Receives the total duration of the file, in 100-nanosecond units. If the duration is unknown, the value is ?1.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The byte stream does not support time-based seeking, or no data is available.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method returns the server response from a previous time-based seek. </p><p><strong>Note</strong>??This method normally cannot be invoked until some data is read from the byte stream, because the <strong><see cref="M:SharpDX.MediaFoundation.ByteStreamTimeSeek.TimeSeek(System.Int64)"/></strong> method does not send a server request immediately.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamTimeSeek::GetTimeSeekResult']/*"/>
|
|
<msdn-id>hh447837</msdn-id>
|
|
<unmanaged>HRESULT IMFByteStreamTimeSeek::GetTimeSeekResult([Out] unsigned longlong* pqwStartTime,[Out] unsigned longlong* pqwStopTime,[Out] unsigned longlong* pqwDuration)</unmanaged>
|
|
<unmanaged-short>IMFByteStreamTimeSeek::GetTimeSeekResult</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ByteStreamTimeSeek.IsTimeSeekSupported">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Queries whether the byte stream supports time-based seeking.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFByteStreamTimeSeek::IsTimeSeekSupported']/*"/>
|
|
<msdn-id>hh447838</msdn-id>
|
|
<unmanaged>IsTimeSeekSupported</unmanaged>
|
|
<unmanaged-short>IsTimeSeekSupported</unmanaged-short>
|
|
<unmanaged>HRESULT IMFByteStreamTimeSeek::IsTimeSeekSupported([Out] BOOL* pfTimeSeekIsSupported)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Clock">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves the last clock time that was correlated with system time. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>At some fixed interval, a clock correlates its internal clock ticks with the system time. (The system time is the time returned by the high-resolution performance counter.) This method returns:</p><ul> <li> The most recent clock time that was correlated with system time. </li> <li> The system time when the correlation was performed. </li> </ul><p> The clock time is returned in the <em>pllClockTime</em> parameter and is expressed in units of the clock's frequency. If the clock's <strong><see cref="M:SharpDX.MediaFoundation.Clock.GetClockCharacteristics(System.Int32@)"/></strong> method returns the <strong><see cref="F:SharpDX.MediaFoundation.ClockCharacteristicsFlags.Frequency10mhz"/></strong> flag, the clock's frequency is 10 MHz (each clock tick is 100 nanoseconds). Otherwise, you can get the clock's frequency by calling <strong><see cref="M:SharpDX.MediaFoundation.Clock.GetProperties(SharpDX.MediaFoundation.ClockProperties@)"/></strong>. The frequency is given in the <strong>qwClockFrequency</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.ClockProperties"/></strong> structure returned by that method. </p><p> The system time is returned in the <em>phnsSystemTime</em> parameter, and is always expressed in 100-nanosecond units. </p><p> To find out how often the clock correlates its clock time with the system time, call <strong>GetProperties</strong>. The correlation interval is given in the <strong>qwCorrelationRate</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.ClockProperties"/></strong> structure. If <strong>qwCorrelationRate</strong> is zero, it means the clock performs the correlation whenever <strong>GetCorrelatedTime</strong> is called. Otherwise, you can calculate the current clock time by extrapolating from the last correlated time. </p><p> Some clocks support rate changes through the <strong><see cref="T:SharpDX.MediaFoundation.RateControl"/></strong> interface. If so, the clock time advances at a speed of frequency ? current rate. If a clock does not expose the <strong><see cref="T:SharpDX.MediaFoundation.RateControl"/></strong> interface, the rate is always 1.0. </p><p>For the presentation clock, the clock time is the presentation time, and is always relative to the starting time specified in <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.Start(System.Int64)"/></strong>. You can also get the presentation time by calling <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.GetTime(System.Int64@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClock']/*"/>
|
|
<msdn-id>ms694122</msdn-id>
|
|
<unmanaged>IMFClock</unmanaged>
|
|
<unmanaged-short>IMFClock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Clock.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Clock"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Clock.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Clock">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Clock"/>. (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.MediaFoundation.Clock.GetClockCharacteristics(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the characteristics of the clock.</p>
|
|
</summary>
|
|
<param name="dwCharacteristicsRef"><dd> <p>Receives a bitwise OR of values from the <strong><see cref="T:SharpDX.MediaFoundation.ClockCharacteristicsFlags"/></strong> enumeration indicating the characteristics of the clock.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClock::GetClockCharacteristics']/*"/>
|
|
<msdn-id>ms697050</msdn-id>
|
|
<unmanaged>HRESULT IMFClock::GetClockCharacteristics([Out] unsigned int* pdwCharacteristics)</unmanaged>
|
|
<unmanaged-short>IMFClock::GetClockCharacteristics</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Clock.GetCorrelatedTime(System.Int32,System.Int64@,System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves the last clock time that was correlated with system time. </p>
|
|
</summary>
|
|
<param name="dwReserved"><dd> <p> Reserved, must be zero. </p> </dd></param>
|
|
<param name="llClockTimeRef"><dd> <p> Receives the last known clock time, in units of the clock's frequency. </p> </dd></param>
|
|
<param name="hnsSystemTimeRef"><dd> <p> Receives the system time that corresponds to the clock time returned in <em>pllClockTime</em>, in 100-nanosecond units. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CLOCK_NO_TIME_SOURCE</strong></dt> </dl> </td><td> <p> The clock does not have a time source. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>At some fixed interval, a clock correlates its internal clock ticks with the system time. (The system time is the time returned by the high-resolution performance counter.) This method returns:</p><ul> <li> The most recent clock time that was correlated with system time. </li> <li> The system time when the correlation was performed. </li> </ul><p> The clock time is returned in the <em>pllClockTime</em> parameter and is expressed in units of the clock's frequency. If the clock's <strong><see cref="M:SharpDX.MediaFoundation.Clock.GetClockCharacteristics(System.Int32@)"/></strong> method returns the <strong><see cref="F:SharpDX.MediaFoundation.ClockCharacteristicsFlags.Frequency10mhz"/></strong> flag, the clock's frequency is 10 MHz (each clock tick is 100 nanoseconds). Otherwise, you can get the clock's frequency by calling <strong><see cref="M:SharpDX.MediaFoundation.Clock.GetProperties(SharpDX.MediaFoundation.ClockProperties@)"/></strong>. The frequency is given in the <strong>qwClockFrequency</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.ClockProperties"/></strong> structure returned by that method. </p><p> The system time is returned in the <em>phnsSystemTime</em> parameter, and is always expressed in 100-nanosecond units. </p><p> To find out how often the clock correlates its clock time with the system time, call <strong>GetProperties</strong>. The correlation interval is given in the <strong>qwCorrelationRate</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.ClockProperties"/></strong> structure. If <strong>qwCorrelationRate</strong> is zero, it means the clock performs the correlation whenever <strong>GetCorrelatedTime</strong> is called. Otherwise, you can calculate the current clock time by extrapolating from the last correlated time. </p><p> Some clocks support rate changes through the <strong><see cref="T:SharpDX.MediaFoundation.RateControl"/></strong> interface. If so, the clock time advances at a speed of frequency ? current rate. If a clock does not expose the <strong><see cref="T:SharpDX.MediaFoundation.RateControl"/></strong> interface, the rate is always 1.0. </p><p>For the presentation clock, the clock time is the presentation time, and is always relative to the starting time specified in <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.Start(System.Int64)"/></strong>. You can also get the presentation time by calling <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.GetTime(System.Int64@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClock::GetCorrelatedTime']/*"/>
|
|
<msdn-id>ms694122</msdn-id>
|
|
<unmanaged>HRESULT IMFClock::GetCorrelatedTime([In] unsigned int dwReserved,[Out] longlong* pllClockTime,[Out] longlong* phnsSystemTime)</unmanaged>
|
|
<unmanaged-short>IMFClock::GetCorrelatedTime</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Clock.GetContinuityKey(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the clock's continuity key. (Not supported.)</p>
|
|
</summary>
|
|
<param name="dwContinuityKeyRef"><dd> <p>Receives the continuity key.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Continuity keys are currently not supported in Media Foundation. Clocks must return the value zero in the <em>pdwContinuityKey</em> parameter.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClock::GetContinuityKey']/*"/>
|
|
<msdn-id>ms700188</msdn-id>
|
|
<unmanaged>HRESULT IMFClock::GetContinuityKey([Out] unsigned int* pdwContinuityKey)</unmanaged>
|
|
<unmanaged-short>IMFClock::GetContinuityKey</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Clock.GetState(System.Int32,SharpDX.MediaFoundation.ClockState@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the current state of the clock.</p>
|
|
</summary>
|
|
<param name="dwReserved"><dd> <p>Reserved, must be zero.</p> </dd></param>
|
|
<param name="eClockStateRef"><dd> <p>Receives the clock state, as a member of the <strong><see cref="T:SharpDX.MediaFoundation.ClockState"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClock::GetState']/*"/>
|
|
<msdn-id>ms700206</msdn-id>
|
|
<unmanaged>HRESULT IMFClock::GetState([In] unsigned int dwReserved,[Out] MFCLOCK_STATE* peClockState)</unmanaged>
|
|
<unmanaged-short>IMFClock::GetState</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Clock.GetProperties(SharpDX.MediaFoundation.ClockProperties@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the properties of the clock.</p>
|
|
</summary>
|
|
<param name="clockPropertiesRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.ClockProperties"/></strong> structure that receives the properties.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClock::GetProperties']/*"/>
|
|
<msdn-id>ms701613</msdn-id>
|
|
<unmanaged>HRESULT IMFClock::GetProperties([Out] MFCLOCK_PROPERTIES* pClockProperties)</unmanaged>
|
|
<unmanaged-short>IMFClock::GetProperties</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Clock.ClockCharacteristics">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the characteristics of the clock.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClock::GetClockCharacteristics']/*"/>
|
|
<msdn-id>ms697050</msdn-id>
|
|
<unmanaged>GetClockCharacteristics</unmanaged>
|
|
<unmanaged-short>GetClockCharacteristics</unmanaged-short>
|
|
<unmanaged>HRESULT IMFClock::GetClockCharacteristics([Out] unsigned int* pdwCharacteristics)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Clock.ContinuityKey">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the clock's continuity key. (Not supported.)</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Continuity keys are currently not supported in Media Foundation. Clocks must return the value zero in the <em>pdwContinuityKey</em> parameter.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClock::GetContinuityKey']/*"/>
|
|
<msdn-id>ms700188</msdn-id>
|
|
<unmanaged>GetContinuityKey</unmanaged>
|
|
<unmanaged-short>GetContinuityKey</unmanaged-short>
|
|
<unmanaged>HRESULT IMFClock::GetContinuityKey([Out] unsigned int* pdwContinuityKey)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Clock.Properties">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the properties of the clock.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClock::GetProperties']/*"/>
|
|
<msdn-id>ms701613</msdn-id>
|
|
<unmanaged>GetProperties</unmanaged>
|
|
<unmanaged-short>GetProperties</unmanaged-short>
|
|
<unmanaged>HRESULT IMFClock::GetProperties([Out] MFCLOCK_PROPERTIES* pClockProperties)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ClockStateSink">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Receives state-change notifications from the presentation clock. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To receive state-change notifications from the presentation clock, implement this interface and call <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.AddClockStateSink(SharpDX.MediaFoundation.ClockStateSink)"/></strong> on the presentation clock.</p><p>This interface must be implemented by:</p><ul> <li> <p>Presentation time sources. The presentation clock uses this interface to request change states from the time source.</p> </li> <li> <p>Media sinks. Media sinks use this interface to get notifications when the presentation clock changes.</p> </li> </ul><p>Other objects that need to be notified can implement this interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClockStateSink']/*"/>
|
|
<msdn-id>ms701593</msdn-id>
|
|
<unmanaged>IMFClockStateSink</unmanaged>
|
|
<unmanaged-short>IMFClockStateSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ClockStateSink.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ClockStateSink"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ClockStateSink.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ClockStateSink">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ClockStateSink"/>. (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.MediaFoundation.ClockStateSink.OnClockStart(System.Int64,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Called when the presentation clock starts. </p>
|
|
</summary>
|
|
<param name="hnsSystemTime"><dd> <p> The system time when the clock started, in 100-nanosecond units. </p> </dd></param>
|
|
<param name="llClockStartOffset"><dd> <p> The new starting time for the clock, in 100-nanosecond units. This parameter can also equal <strong>PRESENTATION_CURRENT_POSITION</strong>, indicating the clock has started or restarted from its current position. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This method is called whe the presentation clock's <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.Start(System.Int64)"/></strong> method is called, with the following exception: If the clock is paused and <strong>Start</strong> is called with the value <strong>PRESENTATION_CURRENT_POSITION</strong>, <strong><see cref="M:SharpDX.MediaFoundation.ClockStateSink.OnClockRestart(System.Int64)"/></strong> is called instead of <strong>OnClockStart</strong>.</p><p>The clock notifies the presentation time source by calling the time source's <strong>OnClockStart</strong> method. This call occurs synchronously within the <strong>Start</strong> method. If the time source returns an error from <strong>OnClockStart</strong>, the presentation clock's <strong>Start</strong> method returns an error and the state change does not take place.</p><p>For any object that is not the presentation time source, the <strong>OnClockStart</strong> method is called asynchronously, after the state change is completed. In that case, the return value from this method is ignored.</p><p>The value given in <em>llClockStartOffset</em> is the presentation time when the clock starts, so it is relative to the start of the presentation. Media sinks should not render any data with a presentation time earlier than <em>llClockStartOffSet</em>. If a sample straddles the offset?that is, if the offset falls between the sample's start and stop times?the sink should either trim the sample so that only data after <em>llClockStartOffset</em> is rendered, or else simply drop the sample.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClockStateSink::OnClockStart']/*"/>
|
|
<msdn-id>ms694879</msdn-id>
|
|
<unmanaged>HRESULT IMFClockStateSink::OnClockStart([In] longlong hnsSystemTime,[In] longlong llClockStartOffset)</unmanaged>
|
|
<unmanaged-short>IMFClockStateSink::OnClockStart</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ClockStateSink.OnClockStop(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Called when the presentation clock stops. </p>
|
|
</summary>
|
|
<param name="hnsSystemTime"><dd> <p> The system time when the clock stopped, in 100-nanosecond units. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SINK_ALREADYSTOPPED</strong></dt> </dl> </td><td> <p>Deprecated. Do not use this error code.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> When the presentation clock's <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.Stop"/></strong> method is called, the clock notifies the presentation time source by calling the presentation time source's <strong>OnClockStop</strong> method. This call occurs synchronously within the <strong>Stop</strong> method. If the time source returns an error from <strong>OnClockStop</strong>, the presentation clock's <strong>Stop</strong> method returns an error and the state change does not take place. </p><p> For any object that is not the presentation time source, the <strong>OnClockStop</strong> method is called asynchronously, after the state change is completed. </p><p>If an object is already stopped, it should return <strong><see cref="F:SharpDX.Result.Ok"/></strong> from <strong>OnClockStop</strong>. It should not return an error code. </p><p><strong>Note</strong>??Although the header file mferror.h defines an error code named <strong>MF_E_SINK_ALREADYSTOPPED</strong>, it should not be returned in this situation.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClockStateSink::OnClockStop']/*"/>
|
|
<msdn-id>ms697009</msdn-id>
|
|
<unmanaged>HRESULT IMFClockStateSink::OnClockStop([In] longlong hnsSystemTime)</unmanaged>
|
|
<unmanaged-short>IMFClockStateSink::OnClockStop</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ClockStateSink.OnClockPause(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Called when the presentation clock pauses. </p>
|
|
</summary>
|
|
<param name="hnsSystemTime"><dd> <p> The system time when the clock was paused, in 100-nanosecond units. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>When the presentation clock's <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.Pause"/></strong> method is called, the clock notifies the presentation time source by calling the time source's <strong>OnClockPause</strong> method. This call occurs synchronously within the <strong>Pause</strong> method. If the time source returns an error from <strong>OnClockPause</strong>, the presentation clock's <strong>Pause</strong> method returns an error and the state change does not take place.</p><p>For any object that is not the presentation time source, the <strong>OnClockPause</strong> method is called asynchronously, after the state change is completed. In that case, the return value from this method is ignored.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClockStateSink::OnClockPause']/*"/>
|
|
<msdn-id>ms703882</msdn-id>
|
|
<unmanaged>HRESULT IMFClockStateSink::OnClockPause([In] longlong hnsSystemTime)</unmanaged>
|
|
<unmanaged-short>IMFClockStateSink::OnClockPause</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ClockStateSink.OnClockRestart(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Called when the presentation clock restarts from the same position while paused. </p>
|
|
</summary>
|
|
<param name="hnsSystemTime"><dd> <p> The system time when the clock restarted, in 100-nanosecond units. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This method is called if the presentation clock is paused and the <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.Start(System.Int64)"/></strong> method is called with the value <strong>PRESENTATION_CURRENT_POSITION</strong>. </p><p> The clock notifies the presentation time source by calling the time source's <strong>OnClockRestart</strong> method. This call occurs synchronously within the <strong>Start</strong> method. If the time source returns an error from <strong>OnClockRestart</strong>, the presentation clock's <strong>Start</strong> method returns an error and the state change does not take place. </p><p> For any object that is not the presentation time source, the <strong>OnClockRestart</strong> method is called asynchronously, after the state change is completed. In that case, the return value from this method is ignored. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClockStateSink::OnClockRestart']/*"/>
|
|
<msdn-id>ms697215</msdn-id>
|
|
<unmanaged>HRESULT IMFClockStateSink::OnClockRestart([In] longlong hnsSystemTime)</unmanaged>
|
|
<unmanaged-short>IMFClockStateSink::OnClockRestart</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ClockStateSink.OnClockSetRate(System.Int64,System.Single)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Called when the rate changes on the presentation clock. </p>
|
|
</summary>
|
|
<param name="hnsSystemTime"><dd> <p> The system time when the rate was set, in 100-nanosecond units. </p> </dd></param>
|
|
<param name="flRate"><dd> <p> The new rate, as a multiplier of the normal playback rate. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> When the presentation clock's <strong><see cref="M:SharpDX.MediaFoundation.RateControl.SetRate(System.Boolean,System.Single)"/></strong> method is called, the clock notifies the presentation time source by calling the time source's <strong>OnClockSetRate</strong> method. This call occurs synchronously within the <strong>SetRate</strong> method. If the time source returns an error from <strong>OnClockSetRate</strong>, the presentation clock's <strong>SetRate</strong> method returns an error and the state change does not take place. </p><p> For any object that is not the presentation time source, the <strong>OnClockSetRate</strong> method is called asynchronously, after the state change is completed. In that case, the return value from this method is ignored. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFClockStateSink::OnClockSetRate']/*"/>
|
|
<msdn-id>ms702979</msdn-id>
|
|
<unmanaged>HRESULT IMFClockStateSink::OnClockSetRate([In] longlong hnsSystemTime,[In] float flRate)</unmanaged>
|
|
<unmanaged-short>IMFClockStateSink::OnClockSetRate</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Collection">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of objects in the collection.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCollection']/*"/>
|
|
<msdn-id>ms697034</msdn-id>
|
|
<unmanaged>IMFCollection</unmanaged>
|
|
<unmanaged-short>IMFCollection</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Collection.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Collection"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Collection.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Collection">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Collection"/>. (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.MediaFoundation.Collection.GetElementCount(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of objects in the collection.</p>
|
|
</summary>
|
|
<param name="cElementsRef"><dd> <p>Receives the number of objects in the collection.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCollection::GetElementCount']/*"/>
|
|
<msdn-id>ms697034</msdn-id>
|
|
<unmanaged>HRESULT IMFCollection::GetElementCount([Out] unsigned int* pcElements)</unmanaged>
|
|
<unmanaged-short>IMFCollection::GetElementCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Collection.GetElement(System.Int32,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves an object in the collection.</p>
|
|
</summary>
|
|
<param name="dwElementIndex"><dd> <p> Zero-based index of the object to retrieve. Objects are indexed in the order in which they were added to the collection. </p> </dd></param>
|
|
<param name="unkElementOut"><dd> <p> Receives a reference to the object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface. The retrieved reference value might be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This method does not remove the object from the collection. To remove an object, call <strong><see cref="M:SharpDX.MediaFoundation.Collection.RemoveElement(System.Int32,SharpDX.ComObject@)"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCollection::GetElement']/*"/>
|
|
<msdn-id>ms701793</msdn-id>
|
|
<unmanaged>HRESULT IMFCollection::GetElement([In] unsigned int dwElementIndex,[Out] IUnknown** ppUnkElement)</unmanaged>
|
|
<unmanaged-short>IMFCollection::GetElement</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Collection.AddElement(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Adds an object to the collection.</p>
|
|
</summary>
|
|
<param name="unkElementRef"><dd> <p>Pointer to the object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If <em>pUnkElement</em> is <strong><c>null</c></strong>, a <strong><c>null</c></strong> reference is added to the collection.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCollection::AddElement']/*"/>
|
|
<msdn-id>ms695202</msdn-id>
|
|
<unmanaged>HRESULT IMFCollection::AddElement([In, Optional] IUnknown* pUnkElement)</unmanaged>
|
|
<unmanaged-short>IMFCollection::AddElement</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Collection.RemoveElement(System.Int32,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Removes an object from the collection.</p>
|
|
</summary>
|
|
<param name="dwElementIndex"><dd> <p>Zero-based index of the object to remove. Objects are indexed in the order in which they were added to the collection.</p> </dd></param>
|
|
<param name="unkElementOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the object. The caller must release the interface. This parameter cannot be <strong><c>null</c></strong>, but the retrieved reference value might be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCollection::RemoveElement']/*"/>
|
|
<msdn-id>ms697010</msdn-id>
|
|
<unmanaged>HRESULT IMFCollection::RemoveElement([In] unsigned int dwElementIndex,[Out] IUnknown** ppUnkElement)</unmanaged>
|
|
<unmanaged-short>IMFCollection::RemoveElement</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Collection.InsertElementAt(System.Int32,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Adds an object at the specified index in the collection.</p>
|
|
</summary>
|
|
<param name="dwIndex"><dd> <p>The zero-based index where the object will be added to the collection.</p> </dd></param>
|
|
<param name="unknownRef"><dd> <p>The object to insert.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCollection::InsertElementAt']/*"/>
|
|
<msdn-id>ms703963</msdn-id>
|
|
<unmanaged>HRESULT IMFCollection::InsertElementAt([In] unsigned int dwIndex,[In, Optional] IUnknown* pUnknown)</unmanaged>
|
|
<unmanaged-short>IMFCollection::InsertElementAt</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Collection.RemoveAllElements">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Removes all items from the collection.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCollection::RemoveAllElements']/*"/>
|
|
<msdn-id>ms700194</msdn-id>
|
|
<unmanaged>HRESULT IMFCollection::RemoveAllElements()</unmanaged>
|
|
<unmanaged-short>IMFCollection::RemoveAllElements</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Collection.ElementCount">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of objects in the collection.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCollection::GetElementCount']/*"/>
|
|
<msdn-id>ms697034</msdn-id>
|
|
<unmanaged>GetElementCount</unmanaged>
|
|
<unmanaged-short>GetElementCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFCollection::GetElementCount([Out] unsigned int* pcElements)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ContentEnabler">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a URL for performing a manual content enabling action.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the enabling action can be performed by navigating to a URL, this method returns the URL. If no such URL exists, the method returns a failure code.</p><p>The purpose of the URL depends on the content enabler type, which is obtained by calling <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableType(System.Guid@)"/></strong>.</p><table> <tr><th>Enable type</th><th>Purpose of URL</th></tr> <tr><td>Individualization</td><td>Not applicable.</td></tr> <tr><td>License acquisition</td><td>URL to obtain the license. Call <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableData(System.Byte[],System.Int32@)"/></strong> and submit the data to the URL as an HTTP POST request. To receive notification when the license is acquired, call <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.MonitorEnable"/></strong>.</td></tr> <tr><td>Revocation</td><td>URL to a webpage where the user can download and install an updated component.</td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentEnabler']/*"/>
|
|
<msdn-id>bb970345</msdn-id>
|
|
<unmanaged>IMFContentEnabler</unmanaged>
|
|
<unmanaged-short>IMFContentEnabler</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentEnabler.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ContentEnabler"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentEnabler.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ContentEnabler">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ContentEnabler"/>. (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.MediaFoundation.ContentEnabler.GetEnableType(System.Guid@)">
|
|
<summary>
|
|
<p>Retrieves the type of operation that this content enabler performs.</p> <see cref="T:SharpDX.Result"/> GetEnableType( <see cref="T:System.Guid"/>* pType
|
|
);<p></p>Parameters <p> pType </p> <p>[out] Receives a <see cref="T:System.Guid"/> that identifies the type of operation. An application can tailor its user interface (UI) strings for known operation types. See Remarks.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr></table> <p>The following GUIDs are defined for the pType parameter.</p> <table><tr> <th> Value </th> <th> Description </th> </tr><tr> <td> <p>MFENABLETYPE_MF_RebootRequired</p> </td> <td> <p>The user must reboot his or her computer.</p> </td> </tr><tr> <td> <p>MFENABLETYPE_MF_UpdateRevocationInformation</p> </td> <td> <p>Update revocation information.</p> </td> </tr><tr> <td> <p>MFENABLETYPE_MF_UpdateUntrustedComponent</p> </td> <td> <p>Update untrusted components.</p> </td> </tr><tr> <td> <p>MFENABLETYPE_WMDRMV1_LicenseAcquisition</p> </td> <td> <p>License acquisition for Windows Media Digital Rights Management (DRM) version 1.</p> </td> </tr><tr> <td> <p>MFENABLETYPE_WMDRMV7_Individualization</p> </td> <td> <p>Individualization.</p> </td> </tr><tr> <td> <p>MFENABLETYPE_WMDRMV7_LicenseAcquisition</p> </td> <td> <p>License acquisition for Windows Media DRM version 7 or later.</p> </td> </tr></table> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFContentEnabler InterfaceConceptsHow to Play Protected Media Files
|
|
</summary>
|
|
<param name="typeRef">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='IMFContentEnabler::GetEnableType']/*"/>
|
|
<msdn-id>ms700192</msdn-id>
|
|
<unmanaged>HRESULT IMFContentEnabler::GetEnableType([Out] GUID* pType)</unmanaged>
|
|
<unmanaged-short>IMFContentEnabler::GetEnableType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableURL(System.IntPtr,System.Int32@,System.IntPtr)">
|
|
<summary>
|
|
<p>Retrieves a URL for performing a manual content enabling action.</p> <see cref="T:SharpDX.Result"/> GetEnableURL( LPWSTR* ppwszURL, DWORD* pcchURL, <see cref="T:SharpDX.MediaFoundation.UrlTrustStatus"/>* pTrustStatus
|
|
);<p></p>Parameters <p> ppwszURL </p> <p>[out] Receives a reference to a buffer that contains the URL. The caller must release the memory for the buffer by calling CoTaskMemFree.</p> <p> pcchURL </p> <p>[out] Receives the length of the string retrieved in ppwszURL, including the terminating <c>null</c> character.</p> <p> pTrustStatus </p> <p>[in, out] Receives a member of the <see cref="T:SharpDX.MediaFoundation.UrlTrustStatus"/> Enumeration indicating whether the URL is trusted. </p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>MF_E_NOT_AVAILABLE</p> </td> <td> <p>No URL is available.</p> </td> </tr></table> <p>If the enabling action can be performed by navigating to a URL, this method returns the URL. If no such URL exists, the method returns a failure code.</p> <p>The purpose of the URL depends on the content enabler type, which is obtained by calling <see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableType(System.Guid@)"/>.</p> <table><tr> <th> Enable type </th> <th> Purpose of URL </th> </tr><tr> <td> <p>Individualization</p> </td> <td> <p>Not applicable.</p> </td> </tr><tr> <td> <p>License acquisition</p> </td> <td> <p>URL to obtain the license. Call <see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableData(System.Byte[],System.Int32@)"/> and submit the data to the URL as an HTTP POST request. To receive notification when the license is acquired, call <see cref="M:SharpDX.MediaFoundation.ContentEnabler.MonitorEnable"/>.</p> </td> </tr><tr> <td> <p>Revocation</p> </td> <td> <p>URL to a Web page where the user can download and install an updated component.</p> </td> </tr></table> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFContentEnabler InterfaceConceptsHow to Play Protected Media Files
|
|
</summary>
|
|
<param name="wszURLOut">No documentation.</param>
|
|
<param name="cchURLRef">No documentation.</param>
|
|
<param name="trustStatusRef">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='IMFContentEnabler::GetEnableURL']/*"/>
|
|
<msdn-id>ms702214</msdn-id>
|
|
<unmanaged>HRESULT IMFContentEnabler::GetEnableURL([Out, Buffer, Optional] wchar_t** ppwszURL,[Out] unsigned int* pcchURL,[InOut, Optional] MF_URL_TRUST_STATUS* pTrustStatus)</unmanaged>
|
|
<unmanaged-short>IMFContentEnabler::GetEnableURL</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableData(System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the data for a manual content enabling action.</p>
|
|
</summary>
|
|
<param name="bDataOut"><dd> <p>Receives a reference to a buffer that contains the data. The caller must free the buffer by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbDataRef"><dd> <p>Receives the size of the <em>ppbData</em> buffer.</p> </dd></param>
|
|
<returns><p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_AVAILABLE</strong></dt> </dl> </td><td> <p>No data is available.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The purpose of the data depends on the content enabler type, which is obtained by calling <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableType(System.Guid@)"/></strong>.</p><table> <tr><th>Enable type</th><th>Purpose of data</th></tr> <tr><td>Individualization</td><td>Not applicable.</td></tr> <tr><td>License acquisition</td><td>HTTP POST data.</td></tr> <tr><td>Revocation</td><td> <strong><see cref="T:SharpDX.MediaFoundation.RrComponents"/></strong> structure.</td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentEnabler::GetEnableData']/*"/>
|
|
<msdn-id>bb970525</msdn-id>
|
|
<unmanaged>HRESULT IMFContentEnabler::GetEnableData([Out, Buffer, Optional] unsigned char** ppbData,[Out] unsigned int* pcbData)</unmanaged>
|
|
<unmanaged-short>IMFContentEnabler::GetEnableData</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentEnabler.IsAutomaticSupported_(System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Queries whether the content enabler can perform all of its actions automatically.</p>
|
|
</summary>
|
|
<param name="fAutomaticRef"><dd> <p>Receives a Boolean value. If <strong>TRUE</strong>, the content enabler can perform the enabing action automatically.</p> </dd></param>
|
|
<returns><p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If this method returns <strong>TRUE</strong> in the <em>pfAutomatic</em> parameter, call the <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.AutomaticEnable"/></strong> method to perform the enabling action.</p><p>If this method returns <strong><see cref="F:SharpDX.Result.False"/></strong> in the <em>pfAutomatic</em> parameter, the application must use manual enabling. To do so, call <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableURL(System.IntPtr,System.Int32@,System.IntPtr)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableData(System.Byte[],System.Int32@)"/></strong> to get the URL and data needed for manual enabling.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentEnabler::IsAutomaticSupported']/*"/>
|
|
<msdn-id>bb970334</msdn-id>
|
|
<unmanaged>HRESULT IMFContentEnabler::IsAutomaticSupported([Out] BOOL* pfAutomatic)</unmanaged>
|
|
<unmanaged-short>IMFContentEnabler::IsAutomaticSupported</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentEnabler.AutomaticEnable">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Performs a content enabling action without any user interaction.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is asynchronous. When the operation is complete, the content enabler sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.EnablerCompleted"/> event. While the operation is in progress, the content enabler might send <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.EnablerProgress"/> events.</p><p>To find out whether the content enabler supports this method, call <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.IsAutomaticSupported_(System.Boolean@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentEnabler::AutomaticEnable']/*"/>
|
|
<msdn-id>ms699012</msdn-id>
|
|
<unmanaged>HRESULT IMFContentEnabler::AutomaticEnable()</unmanaged>
|
|
<unmanaged-short>IMFContentEnabler::AutomaticEnable</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentEnabler.MonitorEnable">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Requests notification when the enabling action is completed.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>S_FALSE</strong></dt> </dl> </td><td> <p>The method succeeded and no action was required.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If you use a manual enabling action, call this method to be notified when the operation completes. If this method returns <see cref="F:SharpDX.Result.Ok"/>, the content enabler will send an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.EnablerCompleted"/> event when the operation is completed. If the application cancels the operatation before completing it, call <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.Cancel"/></strong>.</p><p>You do not have to call <strong>MonitorEnable</strong> when you use automatic enabling by calling <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.AutomaticEnable"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentEnabler::MonitorEnable']/*"/>
|
|
<msdn-id>ms698997</msdn-id>
|
|
<unmanaged>HRESULT IMFContentEnabler::MonitorEnable()</unmanaged>
|
|
<unmanaged-short>IMFContentEnabler::MonitorEnable</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentEnabler.Cancel">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Cancels a pending content enabling action.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The content enabler sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.EnablerCompleted"/> event with a status code of E_CANCEL.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentEnabler::Cancel']/*"/>
|
|
<msdn-id>ms704633</msdn-id>
|
|
<unmanaged>HRESULT IMFContentEnabler::Cancel()</unmanaged>
|
|
<unmanaged-short>IMFContentEnabler::Cancel</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ContentEnabler.EnableType">
|
|
<summary>
|
|
<p>Retrieves the type of operation that this content enabler performs.</p> <see cref="T:SharpDX.Result"/> GetEnableType( <see cref="T:System.Guid"/>* pType
|
|
);<p></p>Parameters <p> pType </p> <p>[out] Receives a <see cref="T:System.Guid"/> that identifies the type of operation. An application can tailor its user interface (UI) strings for known operation types. See Remarks.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr></table> <p>The following GUIDs are defined for the pType parameter.</p> <table><tr> <th> Value </th> <th> Description </th> </tr><tr> <td> <p>MFENABLETYPE_MF_RebootRequired</p> </td> <td> <p>The user must reboot his or her computer.</p> </td> </tr><tr> <td> <p>MFENABLETYPE_MF_UpdateRevocationInformation</p> </td> <td> <p>Update revocation information.</p> </td> </tr><tr> <td> <p>MFENABLETYPE_MF_UpdateUntrustedComponent</p> </td> <td> <p>Update untrusted components.</p> </td> </tr><tr> <td> <p>MFENABLETYPE_WMDRMV1_LicenseAcquisition</p> </td> <td> <p>License acquisition for Windows Media Digital Rights Management (DRM) version 1.</p> </td> </tr><tr> <td> <p>MFENABLETYPE_WMDRMV7_Individualization</p> </td> <td> <p>Individualization.</p> </td> </tr><tr> <td> <p>MFENABLETYPE_WMDRMV7_LicenseAcquisition</p> </td> <td> <p>License acquisition for Windows Media DRM version 7 or later.</p> </td> </tr></table> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFContentEnabler InterfaceConceptsHow to Play Protected Media Files
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentEnabler::GetEnableType']/*"/>
|
|
<msdn-id>ms700192</msdn-id>
|
|
<unmanaged>GetEnableType</unmanaged>
|
|
<unmanaged-short>GetEnableType</unmanaged-short>
|
|
<unmanaged>HRESULT IMFContentEnabler::GetEnableType([Out] GUID* pType)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.ContentEnabler.IsAutomaticSupported">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Queries whether the content enabler can perform all of its actions automatically.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If this method returns <strong>TRUE</strong> in the <em>pfAutomatic</em> parameter, call the <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.AutomaticEnable"/></strong> method to perform the enabling action.</p><p>If this method returns <strong><see cref="F:SharpDX.Result.False"/></strong> in the <em>pfAutomatic</em> parameter, the application must use manual enabling. To do so, call <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableURL(System.IntPtr,System.Int32@,System.IntPtr)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.ContentEnabler.GetEnableData(System.Byte[],System.Int32@)"/></strong> to get the URL and data needed for manual enabling.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentEnabler::IsAutomaticSupported']/*"/>
|
|
<msdn-id>bb970334</msdn-id>
|
|
<unmanaged>IsAutomaticSupported</unmanaged>
|
|
<unmanaged-short>IsAutomaticSupported</unmanaged-short>
|
|
<unmanaged>HRESULT IMFContentEnabler::IsAutomaticSupported([Out] BOOL* pfAutomatic)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ContentProtectionManager">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Enables playback of protected content by providing the application with a reference to a content enabler object.</p><p>Applications that play protected content should implement this interface.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>A <em>content enabler</em> is an object that performs some action that is required to play a piece of protected content. For example, the action might be obtaining a DRM license. Content enablers expose the <strong><see cref="T:SharpDX.MediaFoundation.ContentEnabler"/></strong> interface, which defines a generic mechanism for content enabler. Content enablers are created inside the protected media path (PMP) process. However, they must be invoked from the application process. Therefore, the <strong><see cref="T:SharpDX.MediaFoundation.ContentProtectionManager"/></strong> interface provides a way for the PMP Media Session to notify the application.</p><p>To use this interface, do the following:</p><ol> <li> <p>Implement the interface in your application.</p> </li> <li> <p>Create an attribute store by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAttributes(SharpDX.MediaFoundation.MediaAttributes,System.Int32)"/></strong>.</p> </li> <li> <p>Set the <strong><see cref="F:SharpDX.MediaFoundation.MediaSessionAttributeKeys.ContentProtectionManager"/></strong> attribute on the attribute store. The attribute value is a reference to your <strong><see cref="T:SharpDX.MediaFoundation.ContentProtectionManager"/></strong> implementation.</p> </li> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong> and pass the attribute store in the <em>pConfiguration</em> parameter.</p> </li> </ol><p>If the content requires a content enabler, the application's <strong>BeginEnableContent</strong> method is called. Usually this method called during the <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.SetTopology(System.Int32,SharpDX.MediaFoundation.Topology)"/></strong> operation, before the Media Session raises the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologySet"/> event. The application might receive multiple <strong>BeginEnableContent</strong> calls for a single piece of content. The <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologySet"/> event signals that the content-enabling process is complete for the current topology. The <strong>BeginEnableContent</strong> method can also be called outside of the <strong>SetTopology</strong> operation, but less commonly.</p><p>Many content enablers send machine-specific data to the network, which can have privacy implications. One of the purposes of the <strong><see cref="T:SharpDX.MediaFoundation.ContentProtectionManager"/></strong> interface is to give applications an opportunity to display information to the user and enable to user to opt in or out of the process.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentProtectionManager']/*"/>
|
|
<msdn-id>ms694217</msdn-id>
|
|
<unmanaged>IMFContentProtectionManager</unmanaged>
|
|
<unmanaged-short>IMFContentProtectionManager</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentProtectionManager.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ContentProtectionManager"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentProtectionManager.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ContentProtectionManager">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ContentProtectionManager"/>. (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.MediaFoundation.ContentProtectionManager.BeginEnableContent(SharpDX.MediaFoundation.Activate,SharpDX.MediaFoundation.Topology,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Ends an asynchronous request to perform a content enabling action. This method is called by the protected media path (PMP) to complete an asynchronous call to <strong><see cref="M:SharpDX.MediaFoundation.ContentProtectionManager.BeginEnableContent(SharpDX.MediaFoundation.Activate,SharpDX.MediaFoundation.Topology,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p>
|
|
</summary>
|
|
<param name="enablerActivateRef">No documentation.</param>
|
|
<param name="topoRef">No documentation.</param>
|
|
<param name="callbackRef">No documentation.</param>
|
|
<param name="unkStateRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When the <strong>BeginEnableContent</strong> method completes asynchronously, the application notifies the PMP by invoking the asynchronous callback. The PMP calls <strong>EndEnableContent</strong> on the application to get the result code. This method is called on the application's thread from inside the callback method. Therefore, it must not block the thread that invoked the callback.</p><p>The application must return the success or failure code of the asynchronous processing that followed the call to <strong>BeginEnableContent</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentProtectionManager::BeginEnableContent']/*"/>
|
|
<msdn-id>ms694267</msdn-id>
|
|
<unmanaged>HRESULT IMFContentProtectionManager::BeginEnableContent([In] IMFActivate* pEnablerActivate,[In] IMFTopology* pTopo,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFContentProtectionManager::BeginEnableContent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ContentProtectionManager.EndEnableContent(SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Ends an asynchronous request to perform a content enabling action. This method is called by the protected media path (PMP) to complete an asynchronous call to <strong><see cref="M:SharpDX.MediaFoundation.ContentProtectionManager.BeginEnableContent(SharpDX.MediaFoundation.Activate,SharpDX.MediaFoundation.Topology,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p>
|
|
</summary>
|
|
<param name="resultRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When the <strong>BeginEnableContent</strong> method completes asynchronously, the application notifies the PMP by invoking the asynchronous callback. The PMP calls <strong>EndEnableContent</strong> on the application to get the result code. This method is called on the application's thread from inside the callback method. Therefore, it must not block the thread that invoked the callback.</p><p>The application must return the success or failure code of the asynchronous processing that followed the call to <strong>BeginEnableContent</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFContentProtectionManager::EndEnableContent']/*"/>
|
|
<msdn-id>ms694267</msdn-id>
|
|
<unmanaged>HRESULT IMFContentProtectionManager::EndEnableContent([In] IMFAsyncResult* pResult)</unmanaged>
|
|
<unmanaged-short>IMFContentProtectionManager::EndEnableContent</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.DesiredSample">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Enables the presenter for the enhanced video renderer (EVR) to request a specific frame from the video mixer.</p><p>The sample objects created by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoSampleFromSurface(SharpDX.ComObject,SharpDX.MediaFoundation.Sample@)"/></strong> function implement this interface. To retrieve a reference to this interface, call <strong>QueryInterface</strong> on the sample.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDesiredSample']/*"/>
|
|
<msdn-id>ms696237</msdn-id>
|
|
<unmanaged>IMFDesiredSample</unmanaged>
|
|
<unmanaged-short>IMFDesiredSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DesiredSample.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.DesiredSample"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DesiredSample.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.DesiredSample">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.DesiredSample"/>. (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.MediaFoundation.DesiredSample.GetDesiredSampleTimeAndDuration(System.Int64@,System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called by the mixer to get the time and duration of the sample requested by the presenter.</p>
|
|
</summary>
|
|
<param name="hnsSampleTimeRef"><dd> <p>Receives the desired sample time that should be mixed.</p> </dd></param>
|
|
<param name="hnsSampleDurationRef"><dd> <p>Receives the sample duration that should be mixed.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_AVAILABLE</strong></dt> </dl> </td><td> <p>No time stamp was set for this sample. See <strong><see cref="M:SharpDX.MediaFoundation.DesiredSample.Clear"/></strong>.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDesiredSample::GetDesiredSampleTimeAndDuration']/*"/>
|
|
<msdn-id>ms694058</msdn-id>
|
|
<unmanaged>HRESULT IMFDesiredSample::GetDesiredSampleTimeAndDuration([Out] longlong* phnsSampleTime,[Out] longlong* phnsSampleDuration)</unmanaged>
|
|
<unmanaged-short>IMFDesiredSample::GetDesiredSampleTimeAndDuration</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DesiredSample.SetDesiredSampleTimeAndDuration(System.Int64,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called by the presenter to set the time and duration of the sample that it requests from the mixer.</p>
|
|
</summary>
|
|
<param name="hnsSampleTime"><dd> <p>The time of the requested sample.</p> </dd></param>
|
|
<param name="hnsSampleDuration"><dd> <p>The duration of the requested sample.</p> </dd></param>
|
|
<remarks>
|
|
<p>This value should be set prior to passing the buffer to the mixer for a Mix operation. The mixer sets the actual start and duration times on the sample before sending it back.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDesiredSample::SetDesiredSampleTimeAndDuration']/*"/>
|
|
<msdn-id>ms694296</msdn-id>
|
|
<unmanaged>void IMFDesiredSample::SetDesiredSampleTimeAndDuration([In] longlong hnsSampleTime,[In] longlong hnsSampleDuration)</unmanaged>
|
|
<unmanaged-short>IMFDesiredSample::SetDesiredSampleTimeAndDuration</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DesiredSample.Clear">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Clears the time stamps previously set by a call to <strong><see cref="M:SharpDX.MediaFoundation.DesiredSample.SetDesiredSampleTimeAndDuration(System.Int64,System.Int64)"/></strong>.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>After this method is called, the <strong><see cref="M:SharpDX.MediaFoundation.DesiredSample.GetDesiredSampleTimeAndDuration(System.Int64@,System.Int64@)"/></strong> method returns MF_E_NOT_AVAILABLE.</p><p>This method also clears the time stamp and duration and removes all attributes from the sample.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDesiredSample::Clear']/*"/>
|
|
<msdn-id>ms703903</msdn-id>
|
|
<unmanaged>void IMFDesiredSample::Clear()</unmanaged>
|
|
<unmanaged-short>IMFDesiredSample::Clear</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.DLNASinkInit">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Initializes the Digital Living Network Alliance (DLNA) media sink. </p><p>The DLNA media sink exposes this interface. To get a reference to this interface, call <strong>CoCreateInstance</strong>. The CLSID is <strong>CLSID_MPEG2DLNASink</strong>.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDLNASinkInit']/*"/>
|
|
<msdn-id>dd368787</msdn-id>
|
|
<unmanaged>IMFDLNASinkInit</unmanaged>
|
|
<unmanaged-short>IMFDLNASinkInit</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DLNASinkInit.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.DLNASinkInit"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DLNASinkInit.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.DLNASinkInit">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.DLNASinkInit"/>. (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.MediaFoundation.DLNASinkInit.Initialize(SharpDX.MediaFoundation.ByteStream,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Initializes the Digital Living Network Alliance (DLNA) media sink.</p>
|
|
</summary>
|
|
<param name="byteStreamRef"><dd> <p>Pointer to a byte stream. The DLNA media sink writes data to this byte stream. The byte stream must be writable.</p> </dd></param>
|
|
<param name="fPal"><dd> <p>If <strong>TRUE</strong>, the DLNA media sink accepts PAL video formats. Otherwise, it accepts NTSC video formats.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_ALREADY_INITIALIZED</strong></strong></dt> </dl> </td><td> <p>The method was already called.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The media sink's <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.Shutdown"/></strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDLNASinkInit::Initialize']/*"/>
|
|
<msdn-id>dd368788</msdn-id>
|
|
<unmanaged>HRESULT IMFDLNASinkInit::Initialize([In] IMFByteStream* pByteStream,[In] BOOL fPal)</unmanaged>
|
|
<unmanaged-short>IMFDLNASinkInit::Initialize</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.DRMNetHelper">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Configures Windows Media Digital Rights Management (DRM) for Network Devices on a network sink.</p><p> The Advanced Systems Format (ASF) streaming media sink exposes this interface. To get a reference to the <strong><see cref="T:SharpDX.MediaFoundation.DRMNetHelper"/></strong> interface, perform the following tasks.</p><ol> <li>Get the activation object for the ASF streaming media sink by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateASFStreamingMediaSinkActivate(SharpDX.MediaFoundation.Activate,SharpDX.MediaFoundation.ASFContentInfo,SharpDX.MediaFoundation.Activate@)"/></strong>.</li> <li>Create the media sink by calling the activation object <strong>ActivateObject</strong> method.</li> <li>Get an <strong><see cref="T:SharpDX.MediaFoundation.DRMNetHelper"/></strong> reference by calling <strong>QueryInterface</strong> on the media sink.</li> </ol><p>For more information, see Remarks.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To stream protected content over a network, the <em>ASF streaming media sink</em> provides an output trust authority (OTA) that supports Windows Media DRM for Network Devices and implements the <strong><see cref="T:SharpDX.MediaFoundation.DRMNetHelper"/></strong> interface. For this OTA, encryption occurs on each frame before multiplexing. The license request and response process takes place in the media sink.</p><p>The application gets a reference to <strong><see cref="T:SharpDX.MediaFoundation.DRMNetHelper"/></strong> and uses the methods to handle the license request and response. The application is also responsible for sending the license to the client.</p><p>To stream the content, the application does the following:</p><ol> <li>Provide the HTTP byte stream to which the media sink writes the streamed content. <p>To stream DRM-protected content over a network from a server to a client, an application must use the Microsoft Media Foundation Protected Media Path (PMP). The media sink and the application-provided HTTP byte stream exist in mfpmp.exe. Therefore, the byte stream must expose the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface so that it can be created out-of-process.</p><p><strong>Note</strong>??This might affect how the code is packaged. The DLL that contains the HTTP byte stream and other dependent DLLs must be signed for the Protected Environment (PE-signed). </p> </li> <li>Set the <strong>MFPKEY_ASFMEDIASINK_DRMACTION</strong> property to <strong><see cref="F:SharpDX.MediaFoundation.SinkWmdrmaction.Transcrypt"/></strong>. The media sink's property store is available to the application through the ASF ContentInfo. To get the property store, call <strong><see cref="M:SharpDX.MediaFoundation.ASFContentInfo.GetEncodingConfigurationPropertyStore(System.Int16,SharpDX.ComObject@)"/></strong>.</li> <li>Get a reference to the <strong><see cref="T:SharpDX.MediaFoundation.DRMNetHelper"/></strong> interface by querying the media sink.</li> <li>To make a license request, call <strong><see cref="M:SharpDX.MediaFoundation.DRMNetHelper.ProcessLicenseRequest(System.Byte[],System.Int32,System.Byte[],System.Int32@,System.IntPtr)"/></strong>. This method calls into the OTA implementation and retrieves the license.<p>When the clock starts for the first time or restarts , the encrypter that is used for encrypting samples is retrieved, and the license response is cached.</p> </li> <li>To get the cached license response, call <strong><see cref="M:SharpDX.MediaFoundation.DRMNetHelper.GetChainedLicenseResponse(System.Byte[],System.Int32@)"/></strong>.</li> </ol>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDRMNetHelper']/*"/>
|
|
<msdn-id>dd368789</msdn-id>
|
|
<unmanaged>IMFDRMNetHelper</unmanaged>
|
|
<unmanaged-short>IMFDRMNetHelper</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DRMNetHelper.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.DRMNetHelper"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DRMNetHelper.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.DRMNetHelper">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.DRMNetHelper"/>. (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.MediaFoundation.DRMNetHelper.ProcessLicenseRequest(System.Byte[],System.Int32,System.Byte[],System.Int32@,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the license response for the specified request.</p>
|
|
</summary>
|
|
<param name="licenseRequestRef"><dd> <p>Pointer to a byte array that contains the license request.</p> </dd></param>
|
|
<param name="cbLicenseRequest"><dd> <p>Size, in bytes, of the license request.</p> </dd></param>
|
|
<param name="licenseResponseOut"><dd> <p>Receives a reference to a byte array that contains the license response. The caller must free the array by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbLicenseResponseRef"><dd> <p>Receives the size, in bytes, of the license response.</p> </dd></param>
|
|
<param name="bstrKIDRef"><dd> <p>Receives the key identifier. The caller must release the string by calling <strong>SysFreeString</strong>.</p> </dd></param>
|
|
<returns><p>The function returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink was shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDRMNetHelper::ProcessLicenseRequest']/*"/>
|
|
<msdn-id>dd368791</msdn-id>
|
|
<unmanaged>HRESULT IMFDRMNetHelper::ProcessLicenseRequest([In, Buffer] unsigned char* pLicenseRequest,[In] unsigned int cbLicenseRequest,[Out, Buffer, Optional] unsigned char** ppLicenseResponse,[Out] unsigned int* pcbLicenseResponse,[Out] wchar_t** pbstrKID)</unmanaged>
|
|
<unmanaged-short>IMFDRMNetHelper::ProcessLicenseRequest</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DRMNetHelper.GetChainedLicenseResponse(System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Not implemented in this release.</p>
|
|
</summary>
|
|
<param name="licenseResponseOut"><dd> <p>Receives a reference to a byte array that contains the license response. The caller must free the array by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbLicenseResponseRef"><dd> <p>Receives the size, in bytes, of the license response.</p> </dd></param>
|
|
<returns><p>The method returns <strong>E_NOTIMPL</strong>.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDRMNetHelper::GetChainedLicenseResponse']/*"/>
|
|
<msdn-id>dd368790</msdn-id>
|
|
<unmanaged>HRESULT IMFDRMNetHelper::GetChainedLicenseResponse([Out, Buffer, Optional] unsigned char** ppLicenseResponse,[Out] unsigned int* pcbLicenseResponse)</unmanaged>
|
|
<unmanaged-short>IMFDRMNetHelper::GetChainedLicenseResponse</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.DXGIBuffer">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Queries the Microsoft DirectX Graphics Infrastructure (DXGI) surface for an interface.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>You can use this method to get a reference to the <strong><see cref="!:SharpDX.Direct3D11.Texture2D"/></strong> interface of the surface. If the buffer is locked, the method returns <strong>MF_E_INVALIDREQUEST</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIBuffer']/*"/>
|
|
<msdn-id>hh447902</msdn-id>
|
|
<unmanaged>IMFDXGIBuffer</unmanaged>
|
|
<unmanaged-short>IMFDXGIBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIBuffer.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.DXGIBuffer"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIBuffer.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.DXGIBuffer">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.DXGIBuffer"/>. (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.MediaFoundation.DXGIBuffer.GetResource(System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Queries the Microsoft DirectX Graphics Infrastructure (DXGI) surface for an interface.</p>
|
|
</summary>
|
|
<param name="riid"><dd> <p>The interface identifer (IID) of the interface being requested.</p> </dd></param>
|
|
<param name="vObjectOut"><dd> <p>Receives a reference to the interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong> E_NOINTERFACE</strong></dt> </dl> </td><td> <p>The object does not support the specified interface.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Invalid request.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You can use this method to get a reference to the <strong><see cref="!:SharpDX.Direct3D11.Texture2D"/></strong> interface of the surface. If the buffer is locked, the method returns <strong>MF_E_INVALIDREQUEST</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIBuffer::GetResource']/*"/>
|
|
<msdn-id>hh447902</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIBuffer::GetResource([In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
|
|
<unmanaged-short>IMFDXGIBuffer::GetResource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIBuffer.GetSubresourceIndex(System.Int32@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the index of the subresource that is associated with this media buffer.</p>
|
|
</summary>
|
|
<param name="uSubresourceRef"><dd> <p>Receives the zero-based index of the subresource.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The subresource index is specified when you create the media buffer object. See <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateDXGISurfaceBuffer(System.Guid,SharpDX.ComObject,System.Int32,System.Boolean,SharpDX.MediaFoundation.MediaBuffer@)"/></strong>.</p><p>For more information about texture subresources, see <strong><see cref="!:SharpDX.Direct3D11.Device.CreateTexture2D"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIBuffer::GetSubresourceIndex']/*"/>
|
|
<msdn-id>hh447903</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIBuffer::GetSubresourceIndex([Out] unsigned int* puSubresource)</unmanaged>
|
|
<unmanaged-short>IMFDXGIBuffer::GetSubresourceIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIBuffer.GetUnknown(System.Guid,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets an <strong><see cref="T:SharpDX.ComObject"/></strong> reference that was previously stored in the media buffer object.</p>
|
|
</summary>
|
|
<param name="guid">No documentation.</param>
|
|
<param name="riid">No documentation.</param>
|
|
<param name="vObjectOut">No documentation.</param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong> E_NOINTERFACE</strong></dt> </dl> </td><td> <p>The object does not support the specified interface.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_FOUND</strong></dt> </dl> </td><td> <p>The specified key was not found.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIBuffer::GetUnknown']/*"/>
|
|
<msdn-id>hh447904</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIBuffer::GetUnknown([In] const GUID& guid,[In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
|
|
<unmanaged-short>IMFDXGIBuffer::GetUnknown</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIBuffer.SetUnknown(System.Guid,SharpDX.ComObject)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Stores an arbitrary <strong><see cref="T:SharpDX.ComObject"/></strong> reference in the media buffer object.</p>
|
|
</summary>
|
|
<param name="guid">No documentation.</param>
|
|
<param name="unkDataRef">No documentation.</param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Win32.ErrorCode.ObjectAlreadyExists"/></strong></dt> </dl> </td><td> <p>An item already exists with this key.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To retrieve the reference from the object, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIBuffer.GetUnknown(System.Guid,System.Guid,System.IntPtr@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIBuffer::SetUnknown']/*"/>
|
|
<msdn-id>hh447905</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIBuffer::SetUnknown([In] const GUID& guid,[In, Optional] IUnknown* pUnkData)</unmanaged>
|
|
<unmanaged-short>IMFDXGIBuffer::SetUnknown</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.DXGIBuffer.SubresourceIndex">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the index of the subresource that is associated with this media buffer.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The subresource index is specified when you create the media buffer object. See <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateDXGISurfaceBuffer(System.Guid,SharpDX.ComObject,System.Int32,System.Boolean,SharpDX.MediaFoundation.MediaBuffer@)"/></strong>.</p><p>For more information about texture subresources, see <strong><see cref="!:SharpDX.Direct3D11.Device.CreateTexture2D"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIBuffer::GetSubresourceIndex']/*"/>
|
|
<msdn-id>hh447903</msdn-id>
|
|
<unmanaged>GetSubresourceIndex</unmanaged>
|
|
<unmanaged-short>GetSubresourceIndex</unmanaged-short>
|
|
<unmanaged>HRESULT IMFDXGIBuffer::GetSubresourceIndex([Out] unsigned int* puSubresource)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.DXGIDeviceManager">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gives the caller exclusive access to the Microsoft Direct3D device.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>When you are done using the Direct3D device, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.UnlockDevice(System.IntPtr,System.Boolean)"/></strong> to unlock the device.</p><p>If the method returns <strong>MF_E_DXGI_NEW_VIDEO_DEVICE</strong>, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.CloseDeviceHandle(System.IntPtr)"/></strong> to close the handle and then call <strong>OpenDeviceHandle</strong> again to get a new handle. The <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.ResetDevice(SharpDX.ComObject,System.Int32)"/></strong> method invalidates all open device handles.</p><p>If <em>fBlock</em> is <strong>TRUE</strong>, this method can potentially deadlock. For example, it will deadlock if a thread calls <strong>LockDevice</strong> and then waits on another thread that calls <strong>LockDevice</strong>. It will also deadlock if a thread calls <strong>LockDevice</strong> twice without calling <strong>UnlockDevice</strong> in between. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIDeviceManager']/*"/>
|
|
<msdn-id>hh447909</msdn-id>
|
|
<unmanaged>IMFDXGIDeviceManager</unmanaged>
|
|
<unmanaged-short>IMFDXGIDeviceManager</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIDeviceManager.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.DXGIDeviceManager"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIDeviceManager.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.DXGIDeviceManager">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.DXGIDeviceManager"/>. (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.MediaFoundation.DXGIDeviceManager.CloseDeviceHandle(System.IntPtr)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Closes a Microsoft Direct3D device handle.</p>
|
|
</summary>
|
|
<param name="hDevice"><dd> <p>A handle to the Direct3D device. </p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>E_HANDLE</strong></dt> </dl> </td><td> <p>The specified handle is not a Direct3D device handle.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> Call this method to release a device handle that was retrieved by the <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.OpenDeviceHandle"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIDeviceManager::CloseDeviceHandle']/*"/>
|
|
<msdn-id>hh447907</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIDeviceManager::CloseDeviceHandle([In] void* hDevice)</unmanaged>
|
|
<unmanaged-short>IMFDXGIDeviceManager::CloseDeviceHandle</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIDeviceManager.GetVideoService(System.IntPtr,System.Guid)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Queries the Microsoft Direct3D device for an interface.</p>
|
|
</summary>
|
|
<param name="hDevice"><dd> <p>A handle to the Direct3D device. To get the device handle, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.OpenDeviceHandle"/></strong>.</p> </dd></param>
|
|
<param name="riid"><dd> <p>The interface identifier (IID) of the requested interface. The Direct3D device supports the following interfaces:</p> <ul> <li> <strong><see cref="!:SharpDX.Direct3D11.VideoContext"/></strong> </li> <li> <strong><see cref="!:SharpDX.Direct3D11.VideoDevice"/></strong> </li> </ul> </dd></param>
|
|
<returns><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></returns>
|
|
<remarks>
|
|
<p>If the method returns <strong>MF_E_DXGI_NEW_VIDEO_DEVICE</strong>, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.CloseDeviceHandle(System.IntPtr)"/></strong> to close the handle and then call <strong>OpenDeviceHandle</strong> again to get a new handle. The <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.ResetDevice(SharpDX.ComObject,System.Int32)"/></strong> method invalidates all open device handles.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIDeviceManager::GetVideoService']/*"/>
|
|
<msdn-id>hh447908</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIDeviceManager::GetVideoService([In] void* hDevice,[In] const GUID& riid,[Out] void** ppService)</unmanaged>
|
|
<unmanaged-short>IMFDXGIDeviceManager::GetVideoService</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIDeviceManager.LockDevice(System.IntPtr,System.Guid,System.Boolean)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gives the caller exclusive access to the Microsoft Direct3D device.</p>
|
|
</summary>
|
|
<param name="hDevice"><dd> <p>A handle to the Direct3D device. To get the device handle, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.OpenDeviceHandle"/></strong>.</p> </dd></param>
|
|
<param name="riid"><dd> <p>The interface identifier (IID) of the requested interface. The Direct3D device will support the following interfaces:</p> <ul> <li> <strong><see cref="!:SharpDX.Direct3D11.Device"/></strong> </li> <li> <strong><see cref="!:SharpDX.Direct3D11.VideoContext"/></strong> </li> <li> <strong><see cref="!:SharpDX.Direct3D11.VideoDevice"/></strong> </li> </ul> </dd></param>
|
|
<param name="fBlock"><dd> <p>Specifies whether to wait for the device lock. If the device is already locked and this parameter is <strong>TRUE</strong>, the method blocks until the device is unlocked. Otherwise, if the device is locked and this parameter is <strong><see cref="F:SharpDX.Result.False"/></strong>, the method returns immediately with the error code <strong>DXVA2_E_VIDEO_DEVICE_LOCKED</strong>.</p> </dd></param>
|
|
<returns><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></returns>
|
|
<remarks>
|
|
<p>When you are done using the Direct3D device, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.UnlockDevice(System.IntPtr,System.Boolean)"/></strong> to unlock the device.</p><p>If the method returns <strong>MF_E_DXGI_NEW_VIDEO_DEVICE</strong>, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.CloseDeviceHandle(System.IntPtr)"/></strong> to close the handle and then call <strong>OpenDeviceHandle</strong> again to get a new handle. The <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.ResetDevice(SharpDX.ComObject,System.Int32)"/></strong> method invalidates all open device handles.</p><p>If <em>fBlock</em> is <strong>TRUE</strong>, this method can potentially deadlock. For example, it will deadlock if a thread calls <strong>LockDevice</strong> and then waits on another thread that calls <strong>LockDevice</strong>. It will also deadlock if a thread calls <strong>LockDevice</strong> twice without calling <strong>UnlockDevice</strong> in between. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIDeviceManager::LockDevice']/*"/>
|
|
<msdn-id>hh447909</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIDeviceManager::LockDevice([In] void* hDevice,[In] const GUID& riid,[Out] void** ppUnkDevice,[In] BOOL fBlock)</unmanaged>
|
|
<unmanaged-short>IMFDXGIDeviceManager::LockDevice</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIDeviceManager.OpenDeviceHandle">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets a handle to the Microsoft Direct3D device. </p>
|
|
</summary>
|
|
<returns><dd> <p>Receives the device handle.</p> </dd></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIDeviceManager::OpenDeviceHandle']/*"/>
|
|
<msdn-id>hh447910</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIDeviceManager::OpenDeviceHandle([Out] void** phDevice)</unmanaged>
|
|
<unmanaged-short>IMFDXGIDeviceManager::OpenDeviceHandle</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIDeviceManager.ResetDevice(SharpDX.ComObject,System.Int32)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Sets the Microsoft Direct3D device or notifies the device manager that the Direct3D device was reset.</p>
|
|
</summary>
|
|
<param name="unkDeviceRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the DXGI device.</p> </dd></param>
|
|
<param name="resetToken"><dd> <p>The token that was received in the <em>pResetToken</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateDXGIDeviceManager(System.Int32@,SharpDX.MediaFoundation.DXGIDeviceManager)"/></strong> function. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>When you first create the DXGI Device Manager, call this method with a reference to the Direct3D device. (The device manager does not create the device; the caller must provide the device reference initially.) Also call this method if the Direct3D device becomes lost and you need to reset the device or create a new device. </p><p>The <em>resetToken</em> parameter ensures that only the component that originally created the device manager can invalidate the current device.</p><p>If this method succeeds, all open device handles become invalid.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIDeviceManager::ResetDevice']/*"/>
|
|
<msdn-id>hh447911</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIDeviceManager::ResetDevice([In] IUnknown* pUnkDevice,[In] unsigned int resetToken)</unmanaged>
|
|
<unmanaged-short>IMFDXGIDeviceManager::ResetDevice</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIDeviceManager.TestDevice(System.IntPtr)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Tests whether a Microsoft Direct3D device handle is valid.</p>
|
|
</summary>
|
|
<param name="hDevice"><dd> <p>A handle to the Direct3D device. To get the device handle, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.OpenDeviceHandle"/></strong>.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>E_HANDLE</strong></dt> </dl> </td><td> <p>The specified handle is not a Direct3D device handle.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DXGI_NEW_VIDEO_DEVICE</strong></dt> </dl> </td><td> <p>The device handle is invalid. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the method returns <strong>MF_E_DXGI_NEW_VIDEO_DEVICE</strong>, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.CloseDeviceHandle(System.IntPtr)"/></strong> to close the handle and then call <strong>OpenDeviceHandle</strong> again to get a new handle. The <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.ResetDevice(SharpDX.ComObject,System.Int32)"/></strong> method invalidates all open device handles.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIDeviceManager::TestDevice']/*"/>
|
|
<msdn-id>hh447912</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIDeviceManager::TestDevice([In] void* hDevice)</unmanaged>
|
|
<unmanaged-short>IMFDXGIDeviceManager::TestDevice</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.DXGIDeviceManager.UnlockDevice(System.IntPtr,System.Boolean)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Unlocks the Microsoft Direct3D device.</p>
|
|
</summary>
|
|
<param name="hDevice"><dd> <p>A handle to the Direct3D device. To get the device handle, call <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.OpenDeviceHandle"/></strong>.</p> </dd></param>
|
|
<param name="fSaveState"><dd> <p>Reserved.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> Call this method to release the device after calling <strong><see cref="M:SharpDX.MediaFoundation.DXGIDeviceManager.LockDevice(System.IntPtr,System.Guid,System.Boolean)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFDXGIDeviceManager::UnlockDevice']/*"/>
|
|
<msdn-id>hh447913</msdn-id>
|
|
<unmanaged>HRESULT IMFDXGIDeviceManager::UnlockDevice([In] void* hDevice,[In] BOOL fSaveState)</unmanaged>
|
|
<unmanaged-short>IMFDXGIDeviceManager::UnlockDevice</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.FieldOfUseMFTUnlock">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Enables an application to use a Media Foundation transform (MFT) that has restrictions on its use.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If you register an MFT that requires unlocking, include the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsFieldofuse"/></strong> flag when you call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegister(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],SharpDX.MediaFoundation.MediaAttributes)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFFieldOfUseMFTUnlock']/*"/>
|
|
<msdn-id>dd368792</msdn-id>
|
|
<unmanaged>IMFFieldOfUseMFTUnlock</unmanaged>
|
|
<unmanaged-short>IMFFieldOfUseMFTUnlock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FieldOfUseMFTUnlock.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.FieldOfUseMFTUnlock"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FieldOfUseMFTUnlock.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.FieldOfUseMFTUnlock">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.FieldOfUseMFTUnlock"/>. (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.MediaFoundation.FieldOfUseMFTUnlock.Unlock(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Unlocks a Media Foundation transform (MFT) so that the application can use it.</p>
|
|
</summary>
|
|
<param name="unkMFTRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the MFT.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This method authenticates the caller, using a private communication channel between the MFT and the object that implements the <strong><see cref="T:SharpDX.MediaFoundation.FieldOfUseMFTUnlock"/></strong> interface. The details of the communication depend entirely on the implementation.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFFieldOfUseMFTUnlock::Unlock']/*"/>
|
|
<msdn-id>dd368793</msdn-id>
|
|
<unmanaged>HRESULT IMFFieldOfUseMFTUnlock::Unlock([In, Optional] IUnknown* pUnkMFT)</unmanaged>
|
|
<unmanaged-short>IMFFieldOfUseMFTUnlock::Unlock</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.FilterConfig">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets the number of input pins on the DirectShow <strong>Enhanced Video Renderer</strong> (EVR) filter. To get a reference to this interface, call <strong>QueryInterface</strong> on the DirectShow EVR filter.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The DirectShow EVR filter starts with one input pin, which corresponds to the reference stream. To create additional pins for video substreams, call <strong>SetNumberOfStreams</strong>.</p><p>The EVR media sink for Media Foundation does not support this interface. To add new streams to the EVR media sink, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRFilterConfig']/*"/>
|
|
<msdn-id>ms694298</msdn-id>
|
|
<unmanaged>IEVRFilterConfig</unmanaged>
|
|
<unmanaged-short>IEVRFilterConfig</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FilterConfig.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.FilterConfig"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FilterConfig.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.FilterConfig">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.FilterConfig"/>. (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.MediaFoundation.FilterConfig.SetNumberOfStreams(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the number of input pins on the EVR filter.</p>
|
|
</summary>
|
|
<param name="dwMaxStreams"><dd> <p>Specifies the total number of input pins on the EVR filter. This value includes the input pin for the reference stream, which is created by default. For example, to mix one substream plus the reference stream, set this parameter to 2.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid number of streams. The minimum is one, and the maximum is 16.</p> </td></tr> <tr><td> <dl> <dt><strong>VFW_E_WRONG_STATE</strong></dt> </dl> </td><td> <p>This method has already been called, or at least one pin is already connected.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>After this method has been called, it cannot be called a second time on the same instance of the EVR filter. Also, the method fails if any input pins are connected.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRFilterConfig::SetNumberOfStreams']/*"/>
|
|
<msdn-id>ms698968</msdn-id>
|
|
<unmanaged>HRESULT IEVRFilterConfig::SetNumberOfStreams([In] unsigned int dwMaxStreams)</unmanaged>
|
|
<unmanaged-short>IEVRFilterConfig::SetNumberOfStreams</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FilterConfig.GetNumberOfStreams(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of input pins on the EVR filter. The EVR filter always has at least one input pin, which corresponds to the reference stream.</p>
|
|
</summary>
|
|
<param name="dwMaxStreamsRef"><dd> <p>Receives the number of streams.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRFilterConfig::GetNumberOfStreams']/*"/>
|
|
<msdn-id>ms701550</msdn-id>
|
|
<unmanaged>HRESULT IEVRFilterConfig::GetNumberOfStreams([Out] unsigned int* pdwMaxStreams)</unmanaged>
|
|
<unmanaged-short>IEVRFilterConfig::GetNumberOfStreams</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.FilterConfig.NumberOfStreams">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of input pins on the EVR filter. The EVR filter always has at least one input pin, which corresponds to the reference stream.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRFilterConfig::GetNumberOfStreams']/*"/>
|
|
<msdn-id>ms701550</msdn-id>
|
|
<unmanaged>GetNumberOfStreams</unmanaged>
|
|
<unmanaged-short>GetNumberOfStreams</unmanaged-short>
|
|
<unmanaged>HRESULT IEVRFilterConfig::GetNumberOfStreams([Out] unsigned int* pdwMaxStreams)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.FilterConfigEx">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Configures the DirectShow <strong>Enhanced Video Renderer</strong> (EVR) filter. To get a reference to this interface, call <strong>QueryInterface</strong> on the EVR filter.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRFilterConfigEx']/*"/>
|
|
<msdn-id>dd373924</msdn-id>
|
|
<unmanaged>IEVRFilterConfigEx</unmanaged>
|
|
<unmanaged-short>IEVRFilterConfigEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FilterConfigEx.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.FilterConfigEx"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FilterConfigEx.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.FilterConfigEx">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.FilterConfigEx"/>. (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.MediaFoundation.FilterConfigEx.SetConfigPrefs(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets the configuration parameters for the Microsoft DirectShow <strong>Enhanced Video Renderer Filter</strong> (EVR).</p>
|
|
</summary>
|
|
<param name="dwConfigFlags">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRFilterConfigEx::SetConfigPrefs']/*"/>
|
|
<msdn-id>dd373926</msdn-id>
|
|
<unmanaged>HRESULT IEVRFilterConfigEx::SetConfigPrefs([In] unsigned int dwConfigFlags)</unmanaged>
|
|
<unmanaged-short>IEVRFilterConfigEx::SetConfigPrefs</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FilterConfigEx.GetConfigPrefs(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the configuration parameters for the Microsoft DirectShow <strong>Enhanced Video Renderer Filter</strong> filter.</p>
|
|
</summary>
|
|
<param name="dwConfigFlagsRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRFilterConfigEx::GetConfigPrefs']/*"/>
|
|
<msdn-id>dd373925</msdn-id>
|
|
<unmanaged>HRESULT IEVRFilterConfigEx::GetConfigPrefs([Out] unsigned int* pdwConfigFlags)</unmanaged>
|
|
<unmanaged-short>IEVRFilterConfigEx::GetConfigPrefs</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.FilterConfigEx.ConfigPrefs">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the configuration parameters for the Microsoft DirectShow <strong>Enhanced Video Renderer Filter</strong> filter.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRFilterConfigEx::GetConfigPrefs']/*"/>
|
|
<msdn-id>dd373925</msdn-id>
|
|
<unmanaged>GetConfigPrefs</unmanaged>
|
|
<unmanaged-short>GetConfigPrefs</unmanaged-short>
|
|
<unmanaged>HRESULT IEVRFilterConfigEx::GetConfigPrefs([Out] unsigned int* pdwConfigFlags)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.FinalizableMediaSink">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Notifies the media sink to asynchronously take any steps it needs to finish its tasks.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Many archive media sinks have steps they need to do at the end of archiving to complete their file operations, such as updating the header (for some formats) or flushing all pending writes to disk. In some cases, this may include expensive operations such as indexing the content. <strong>BeginFinalize</strong> is an asynchronous way to initiate final tasks.</p><p>When the finalize operation is complete, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.FinalizableMediaSink.EndFinalize(SharpDX.MediaFoundation.AsyncResult)"/></strong> to complete the asynchronous request.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFFinalizableMediaSink']/*"/>
|
|
<msdn-id>ms705643</msdn-id>
|
|
<unmanaged>IMFFinalizableMediaSink</unmanaged>
|
|
<unmanaged-short>IMFFinalizableMediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaSink">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Implemented by media sink objects. This interface is the base interface for all Media Foundation media sinks. Stream sinks handle the actual processing of data on each stream.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink']/*"/>
|
|
<msdn-id>ms694262</msdn-id>
|
|
<unmanaged>IMFMediaSink</unmanaged>
|
|
<unmanaged-short>IMFMediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSink.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaSink"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSink.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaSink">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaSink"/>. (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.MediaFoundation.MediaSink.GetCharacteristics(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gets the characteristics of the media sink.</p>
|
|
</summary>
|
|
<param name="dwCharacteristicsRef"><dd> <p> Receives a bitwise <strong>OR</strong> of zero or more flags. The following flags are defined: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><strong>MEDIASINK_FIXED_STREAMS</strong></strong></dt> <dt>0x00000001</dt> </dl> </td><td> <p> The media sink has a fixed number of streams. It does not support the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.RemoveStreamSink(System.Int32)"/></strong> methods. This flag is a hint to the application. </p> </td></tr> <tr><td><dl> <dt><strong><strong>MEDIASINK_CANNOT_MATCH_CLOCK</strong></strong></dt> <dt>0x00000002</dt> </dl> </td><td> <p>The media sink cannot match rates with an external clock.</p> <p>For best results, this media sink should be used as the time source for the presentation clock. If any other time source is used, the media sink cannot match rates with the clock, with poor results (for example, glitching).</p> <p>This flag should be used sparingly, because it limits how the pipeline can be configured.</p> <p>For more information about the presentation clock, see Presentation Clock.</p> </td></tr> <tr><td><dl> <dt><strong><strong>MEDIASINK_RATELESS</strong></strong></dt> <dt>0x00000004</dt> </dl> </td><td> <p>The media sink is rateless. It consumes samples as quickly as possible, and does not synchronize itself to a presentation clock.</p> <p>Most archiving sinks are rateless.</p> </td></tr> <tr><td><dl> <dt><strong><strong>MEDIASINK_CLOCK_REQUIRED</strong></strong></dt> <dt>0x00000008</dt> </dl> </td><td> <p>The media sink requires a presentation clock. The presentation clock is set by calling the media sink's <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.SetPresentationClock(SharpDX.MediaFoundation.PresentationClock)"/></strong> method.</p> <p>This flag is obsolete, because all media sinks must support the <strong>SetPresentationClock</strong> method, even if the media sink ignores the clock (as in a rateless media sink).</p> </td></tr> <tr><td><dl> <dt><strong><strong>MEDIASINK_CAN_PREROLL</strong></strong></dt> <dt>0x00000010</dt> </dl> </td><td> <p> The media sink can accept preroll samples before the presentation clock starts. The media sink exposes the <strong><see cref="T:SharpDX.MediaFoundation.MediaSinkPreroll"/></strong> interface. </p> </td></tr> <tr><td><dl> <dt><strong><strong>MEDIASINK_REQUIRE_REFERENCE_MEDIATYPE</strong></strong></dt> <dt>0x00000020</dt> </dl> </td><td> <p>The first stream sink (index 0) is a reference stream. The reference stream must have a media type before the media types can be set on the other stream sinks.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p> The media sink's <strong>Shutdown</strong> method has been called. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> The characteristics of a media sink are fixed throughout the life time of the sink. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::GetCharacteristics']/*"/>
|
|
<msdn-id>ms701973</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSink::GetCharacteristics([Out] unsigned int* pdwCharacteristics)</unmanaged>
|
|
<unmanaged-short>IMFMediaSink::GetCharacteristics</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Adds a new stream sink to the media sink.</p>
|
|
</summary>
|
|
<param name="dwStreamSinkIdentifier"><dd> <p>Identifier for the new stream. The value is arbitrary but must be unique.</p> </dd></param>
|
|
<param name="mediaTypeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface, specifying the media type for the stream. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="streamSinkOut"><dd> <p>Receives a reference to the new stream sink's <strong><see cref="T:SharpDX.MediaFoundation.StreamSink"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p>The specified stream identifier is not valid.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINK_EXISTS</strong></dt> </dl> </td><td> <p>There is already a stream sink with the same stream identifier.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINKS_FIXED</strong></dt> </dl> </td><td> <p>This media sink has a fixed set of stream sinks. New stream sinks cannot be added.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Not all media sinks support this method. If the media sink does not support this method, the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.GetCharacteristics(System.Int32@)"/></strong> method returns the MEDIASINK_FIXED_STREAMS flag.</p><p>If <em>pMediaType</em> is <strong><c>null</c></strong>, use the <strong><see cref="T:SharpDX.MediaFoundation.MediaTypeHandler"/></strong> interface to set the media type. Call <strong><see cref="M:SharpDX.MediaFoundation.StreamSink.GetMediaTypeHandler(SharpDX.MediaFoundation.MediaTypeHandler@)"/></strong> to get a reference to the interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::AddStreamSink']/*"/>
|
|
<msdn-id>ms694890</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSink::AddStreamSink([In] unsigned int dwStreamSinkIdentifier,[In, Optional] IMFMediaType* pMediaType,[Out] IMFStreamSink** ppStreamSink)</unmanaged>
|
|
<unmanaged-short>IMFMediaSink::AddStreamSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSink.RemoveStreamSink(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Removes a stream sink from the media sink.</p>
|
|
</summary>
|
|
<param name="dwStreamSinkIdentifier"><dd> <p>Identifier of the stream to remove. The stream identifier is defined when you call <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong> to add the stream sink.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>This particular stream sink cannot be removed.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p>The stream number is not valid.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The media sink has not been initialized.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINKS_FIXED</strong></dt> </dl> </td><td> <p>This media sink has a fixed set of stream sinks. Stream sinks cannot be removed.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>After this method is called, the corresponding stream sink object is no longer valid. The <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.GetStreamSinkByIndex(System.Int32,SharpDX.MediaFoundation.StreamSink@)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.GetStreamSinkById(System.Int32,SharpDX.MediaFoundation.StreamSink@)"/></strong> methods will no longer return that stream sink. You can re-use the stream identifier if you add another stream (by calling <strong>AddStreamSink</strong>).</p><p>Not all media sinks support this method. If the media sink does not support this method, the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.GetCharacteristics(System.Int32@)"/></strong> method returns the MEDIASINK_FIXED_STREAMS flag.</p><p>In some cases, the media sink supports this method but does not allow every stream sink to be removed. (For example, it might not allow stream 0 to be removed.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::RemoveStreamSink']/*"/>
|
|
<msdn-id>ms705627</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSink::RemoveStreamSink([In] unsigned int dwStreamSinkIdentifier)</unmanaged>
|
|
<unmanaged-short>IMFMediaSink::RemoveStreamSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSink.GetStreamSinkCount(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gets the number of stream sinks on this media sink.</p>
|
|
</summary>
|
|
<param name="cStreamSinkCountRef"><dd> <p>Receives the number of stream sinks.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::GetStreamSinkCount']/*"/>
|
|
<msdn-id>ms703020</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSink::GetStreamSinkCount([Out] unsigned int* pcStreamSinkCount)</unmanaged>
|
|
<unmanaged-short>IMFMediaSink::GetStreamSinkCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSink.GetStreamSinkByIndex(System.Int32,SharpDX.MediaFoundation.StreamSink@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gets a stream sink, specified by index.</p>
|
|
</summary>
|
|
<param name="dwIndex"><dd> <p>Zero-based index of the stream. To get the number of streams, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.GetStreamSinkCount(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<param name="streamSinkOut"><dd> <p>Receives a reference to the stream's <strong><see cref="T:SharpDX.MediaFoundation.StreamSink"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDINDEX</strong></dt> </dl> </td><td> <p>Invalid index.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Enumerating stream sinks is not a thread-safe operation, because stream sinks can be added or removed between calls to this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::GetStreamSinkByIndex']/*"/>
|
|
<msdn-id>ms693512</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSink::GetStreamSinkByIndex([In] unsigned int dwIndex,[Out] IMFStreamSink** ppStreamSink)</unmanaged>
|
|
<unmanaged-short>IMFMediaSink::GetStreamSinkByIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSink.GetStreamSinkById(System.Int32,SharpDX.MediaFoundation.StreamSink@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gets a stream sink, specified by stream identifier.</p>
|
|
</summary>
|
|
<param name="dwStreamSinkIdentifier"><dd> <p>Stream identifier of the stream sink.</p> </dd></param>
|
|
<param name="streamSinkOut"><dd> <p>Receives a reference to the stream's <strong><see cref="T:SharpDX.MediaFoundation.StreamSink"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p>The stream identifier is not valid.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If you add a stream sink by calling the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong> method, the stream identifier is specified in the <em>dwStreamSinkIdentifier</em> parameter of that method. If the media sink has a fixed set of streams, the media sink assigns the stream identifiers.</p><p>To enumerate the streams by index number instead of stream identifier, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.GetStreamSinkByIndex(System.Int32,SharpDX.MediaFoundation.StreamSink@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::GetStreamSinkById']/*"/>
|
|
<msdn-id>ms695360</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSink::GetStreamSinkById([In] unsigned int dwStreamSinkIdentifier,[Out] IMFStreamSink** ppStreamSink)</unmanaged>
|
|
<unmanaged-short>IMFMediaSink::GetStreamSinkById</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSink.SetPresentationClock(SharpDX.MediaFoundation.PresentationClock)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the presentation clock on the media sink.</p>
|
|
</summary>
|
|
<param name="presentationClockRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.PresentationClock"/></strong> interface of the presentation clock, or <strong><c>null</c></strong>. If the value is <strong><c>null</c></strong>, the media sink stops listening to the presentaton clock that was previously set, if any.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CLOCK_NO_TIME_SOURCE</strong></dt> </dl> </td><td> <p>The presentation clock does not have a time source. Call <strong>SetTimeSource</strong> on the presentation clock.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>During streaming, the media sink attempts to match rates with the presentation clock. Ideally, the media sink presents samples at the correct time according to the presentation clock and does not fall behind. Rateless media sinks are an exception to this rule, as they consume samples as quickly as possible and ignore the clock. If the sink is rateless, the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.GetCharacteristics(System.Int32@)"/></strong> method returns the MEDIASINK_RATELESS flag.</p><p>The presentation clock must have a time source. Before calling this method, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.SetTimeSource(SharpDX.MediaFoundation.PresentationTimeSource)"/></strong> on the presentation clock to set the presentation time source. Some media sinks provide time sources; therefore, the media sink might be the time source for its own presentation clock. Regardless of what object provides the time source, however, the media sink must attempt to match rates with the clock specified in <em>pPresentationClock</em>. If a media sink cannot match rates with an external time source, the media sink's <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.GetCharacteristics(System.Int32@)"/></strong> method retrieves the MEDIASINK_CANNOT_MATCH_CLOCK flag. In this case, <strong>SetPresentationClock</strong> will still succeed, but the results will not be optimal. The sink might not render samples quickly enough to match rates with the presentation clock.</p><p>If <em>pPresentationClock</em> is non-<strong><c>null</c></strong>, the media sink must register for clock state notifications, by calling <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.AddClockStateSink(SharpDX.MediaFoundation.ClockStateSink)"/></strong> on the presentation clock. If the method is called again with a new presentation clock, or if <em>pPresentationClock</em> is <strong><c>null</c></strong>, the media sink must call <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.RemoveClockStateSink(SharpDX.MediaFoundation.ClockStateSink)"/></strong> to deregister itself from the previous clock.</p><p>All media sinks must support this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::SetPresentationClock']/*"/>
|
|
<msdn-id>ms700160</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSink::SetPresentationClock([In, Optional] IMFPresentationClock* pPresentationClock)</unmanaged>
|
|
<unmanaged-short>IMFMediaSink::SetPresentationClock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSink.GetPresentationClock(SharpDX.MediaFoundation.PresentationClock@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gets the presentation clock that was set on the media sink.</p>
|
|
</summary>
|
|
<param name="presentationClockOut"><dd> <p>Receives a reference to the presentation clock's <strong><see cref="T:SharpDX.MediaFoundation.PresentationClock"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_CLOCK</strong></dt> </dl> </td><td> <p>No clock has been set. To set the presentation clock, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.SetPresentationClock(SharpDX.MediaFoundation.PresentationClock)"/></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::GetPresentationClock']/*"/>
|
|
<msdn-id>ms705665</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSink::GetPresentationClock([Out] IMFPresentationClock** ppPresentationClock)</unmanaged>
|
|
<unmanaged-short>IMFMediaSink::GetPresentationClock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSink.Shutdown">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Shuts down the media sink and releases the resources it is using.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink was shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the application creates the media sink, it is responsible for calling <strong>Shutdown</strong> to avoid memory or resource leaks. In most applications, however, the application creates an activation object for the media sink, and the Media Session uses that object to create the media sink. In that case, the Media Session ? not the application ? shuts down the media sink. (For more information, see Activation Objects.)</p><p>After this method returns, all methods on the media sink return MF_E_SHUTDOWN, except for <strong><see cref="T:SharpDX.ComObject"/></strong> methods and <strong><see cref="T:SharpDX.MediaFoundation.MediaEventGenerator"/></strong> methods. The sink will not raise any events after this method is called.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::Shutdown']/*"/>
|
|
<msdn-id>ms702084</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSink::Shutdown()</unmanaged>
|
|
<unmanaged-short>IMFMediaSink::Shutdown</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaSink.Characteristics">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gets the characteristics of the media sink.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> The characteristics of a media sink are fixed throughout the life time of the sink. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::GetCharacteristics']/*"/>
|
|
<msdn-id>ms701973</msdn-id>
|
|
<unmanaged>GetCharacteristics</unmanaged>
|
|
<unmanaged-short>GetCharacteristics</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaSink::GetCharacteristics([Out] unsigned int* pdwCharacteristics)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaSink.StreamSinkCount">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gets the number of stream sinks on this media sink.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::GetStreamSinkCount']/*"/>
|
|
<msdn-id>ms703020</msdn-id>
|
|
<unmanaged>GetStreamSinkCount</unmanaged>
|
|
<unmanaged-short>GetStreamSinkCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaSink::GetStreamSinkCount([Out] unsigned int* pcStreamSinkCount)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaSink.PresentationClock">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gets the presentation clock that was set on the media sink.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSink::GetPresentationClock']/*"/>
|
|
<msdn-id>ms705665</msdn-id>
|
|
<unmanaged>GetPresentationClock</unmanaged>
|
|
<unmanaged-short>GetPresentationClock</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaSink::GetPresentationClock([Out] IMFPresentationClock** ppPresentationClock)</unmanaged>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FinalizableMediaSink.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.FinalizableMediaSink"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FinalizableMediaSink.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.FinalizableMediaSink">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.FinalizableMediaSink"/>. (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.MediaFoundation.FinalizableMediaSink.BeginFinalize(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Notifies the media sink to asynchronously take any steps it needs to finish its tasks.</p>
|
|
</summary>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of an asynchronous object. The caller must implement this interface.</p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Many archive media sinks have steps they need to do at the end of archiving to complete their file operations, such as updating the header (for some formats) or flushing all pending writes to disk. In some cases, this may include expensive operations such as indexing the content. <strong>BeginFinalize</strong> is an asynchronous way to initiate final tasks.</p><p>When the finalize operation is complete, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.FinalizableMediaSink.EndFinalize(SharpDX.MediaFoundation.AsyncResult)"/></strong> to complete the asynchronous request.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFFinalizableMediaSink::BeginFinalize']/*"/>
|
|
<msdn-id>ms705643</msdn-id>
|
|
<unmanaged>HRESULT IMFFinalizableMediaSink::BeginFinalize([In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFFinalizableMediaSink::BeginFinalize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.FinalizableMediaSink.EndFinalize(SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Completes an asynchronous finalize operation.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method after the <strong><see cref="M:SharpDX.MediaFoundation.FinalizableMediaSink.BeginFinalize(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFFinalizableMediaSink::EndFinalize']/*"/>
|
|
<msdn-id>ms694891</msdn-id>
|
|
<unmanaged>HRESULT IMFFinalizableMediaSink::EndFinalize([In] IMFAsyncResult* pResult)</unmanaged>
|
|
<unmanaged-short>IMFFinalizableMediaSink::EndFinalize</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.IDMOQualityControl">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDMOQualityControl']/*"/>
|
|
<unmanaged>IDMOQualityControl</unmanaged>
|
|
<unmanaged-short>IDMOQualityControl</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IDMOQualityControl.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.IDMOQualityControl"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IDMOQualityControl.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.IDMOQualityControl">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.IDMOQualityControl"/>. (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.MediaFoundation.IDMOQualityControl.SetNow(System.Int64)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="rtNow">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='IDMOQualityControl::SetNow']/*"/>
|
|
<unmanaged>HRESULT IDMOQualityControl::SetNow([In] longlong rtNow)</unmanaged>
|
|
<unmanaged-short>IDMOQualityControl::SetNow</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IDMOQualityControl.SetStatus(System.Int32)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwFlags">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='IDMOQualityControl::SetStatus']/*"/>
|
|
<unmanaged>HRESULT IDMOQualityControl::SetStatus([In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IDMOQualityControl::SetStatus</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IDMOQualityControl.GetStatus(System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwFlagsRef">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='IDMOQualityControl::GetStatus']/*"/>
|
|
<unmanaged>HRESULT IDMOQualityControl::GetStatus([Out] unsigned int* pdwFlags)</unmanaged>
|
|
<unmanaged-short>IDMOQualityControl::GetStatus</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.IDMOQualityControl.Now">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDMOQualityControl::SetNow']/*"/>
|
|
<unmanaged>SetNow</unmanaged>
|
|
<unmanaged-short>SetNow</unmanaged-short>
|
|
<unmanaged>HRESULT IDMOQualityControl::SetNow([In] longlong rtNow)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.IDMOQualityControl.Status">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDMOQualityControl::GetStatus']/*"/>
|
|
<unmanaged>GetStatus</unmanaged>
|
|
<unmanaged-short>GetStatus</unmanaged-short>
|
|
<unmanaged>HRESULT IDMOQualityControl::GetStatus([Out] unsigned int* pdwFlags)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.IDMOVideoOutputOptimizations">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDMOVideoOutputOptimizations']/*"/>
|
|
<unmanaged>IDMOVideoOutputOptimizations</unmanaged>
|
|
<unmanaged-short>IDMOVideoOutputOptimizations</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IDMOVideoOutputOptimizations.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.IDMOVideoOutputOptimizations"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IDMOVideoOutputOptimizations.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.IDMOVideoOutputOptimizations">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.IDMOVideoOutputOptimizations"/>. (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.MediaFoundation.IDMOVideoOutputOptimizations.QueryOperationModePreferences(System.Int32,System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="ulOutputStreamIndex">No documentation.</param>
|
|
<param name="dwRequestedCapabilitiesRef">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='IDMOVideoOutputOptimizations::QueryOperationModePreferences']/*"/>
|
|
<unmanaged>HRESULT IDMOVideoOutputOptimizations::QueryOperationModePreferences([In] unsigned int ulOutputStreamIndex,[Out] unsigned int* pdwRequestedCapabilities)</unmanaged>
|
|
<unmanaged-short>IDMOVideoOutputOptimizations::QueryOperationModePreferences</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IDMOVideoOutputOptimizations.SetOperationMode(System.Int32,System.Int32)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="ulOutputStreamIndex">No documentation.</param>
|
|
<param name="dwEnabledFeatures">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='IDMOVideoOutputOptimizations::SetOperationMode']/*"/>
|
|
<unmanaged>HRESULT IDMOVideoOutputOptimizations::SetOperationMode([In] unsigned int ulOutputStreamIndex,[In] unsigned int dwEnabledFeatures)</unmanaged>
|
|
<unmanaged-short>IDMOVideoOutputOptimizations::SetOperationMode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IDMOVideoOutputOptimizations.GetCurrentOperationMode(System.Int32,System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="ulOutputStreamIndex">No documentation.</param>
|
|
<param name="dwEnabledFeaturesRef">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='IDMOVideoOutputOptimizations::GetCurrentOperationMode']/*"/>
|
|
<unmanaged>HRESULT IDMOVideoOutputOptimizations::GetCurrentOperationMode([In] unsigned int ulOutputStreamIndex,[Out] unsigned int* pdwEnabledFeatures)</unmanaged>
|
|
<unmanaged-short>IDMOVideoOutputOptimizations::GetCurrentOperationMode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IDMOVideoOutputOptimizations.GetCurrentSampleRequirements(System.Int32,System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="ulOutputStreamIndex">No documentation.</param>
|
|
<param name="dwRequestedFeaturesRef">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='IDMOVideoOutputOptimizations::GetCurrentSampleRequirements']/*"/>
|
|
<unmanaged>HRESULT IDMOVideoOutputOptimizations::GetCurrentSampleRequirements([In] unsigned int ulOutputStreamIndex,[Out] unsigned int* pdwRequestedFeatures)</unmanaged>
|
|
<unmanaged-short>IDMOVideoOutputOptimizations::GetCurrentSampleRequirements</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.IEnumDMO">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code><see cref="T:SharpDX.MediaFoundation.IEnumDMO"/></code> interface provides methods for enumerating Microsoft DirectX Media Objects (DMOs). It is based on the OLE enumeration interfaces. For more information, see the <em>IEnumXXXX</em> topic in the Platform SDK.</p><p>To enumerate registered DMOs, call the <strong>DMOEnum</strong> function.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEnumDMO']/*"/>
|
|
<msdn-id>dd376585</msdn-id>
|
|
<unmanaged>IEnumDMO</unmanaged>
|
|
<unmanaged-short>IEnumDMO</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IEnumDMO.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.IEnumDMO"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IEnumDMO.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.IEnumDMO">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.IEnumDMO"/>. (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.MediaFoundation.IEnumDMO.Next(System.Int32,System.Guid[],System.IntPtr,System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="cItemsToFetch">No documentation.</param>
|
|
<param name="cLSIDRef">No documentation.</param>
|
|
<param name="names">No documentation.</param>
|
|
<param name="cItemsFetchedRef">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='IEnumDMO::Next']/*"/>
|
|
<msdn-id>ms785641</msdn-id>
|
|
<unmanaged>HRESULT IEnumDMO::Next([In] unsigned int cItemsToFetch,[Out, Buffer] GUID* pCLSID,[Out, Buffer] wchar_t** Names,[Out] unsigned int* pcItemsFetched)</unmanaged>
|
|
<unmanaged-short>IEnumDMO::Next</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IEnumDMO.Skip(System.Int32)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="cItemsToSkip">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='IEnumDMO::Skip']/*"/>
|
|
<unmanaged>HRESULT IEnumDMO::Skip([In] unsigned int cItemsToSkip)</unmanaged>
|
|
<unmanaged-short>IEnumDMO::Skip</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IEnumDMO.Reset">
|
|
<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='IEnumDMO::Reset']/*"/>
|
|
<unmanaged>HRESULT IEnumDMO::Reset()</unmanaged>
|
|
<unmanaged-short>IEnumDMO::Reset</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IEnumDMO.Clone(SharpDX.MediaFoundation.IEnumDMO@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>This method is not implemented.</p>
|
|
</summary>
|
|
<param name="enumOut"><dd> <p>Reserved.</p> </dd></param>
|
|
<returns><p>Returns E_NOTIMPL.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEnumDMO::Clone']/*"/>
|
|
<msdn-id>dd376586</msdn-id>
|
|
<unmanaged>HRESULT IEnumDMO::Clone([Out] IEnumDMO** ppEnum)</unmanaged>
|
|
<unmanaged-short>IEnumDMO::Clone</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.IMediaBuffer">
|
|
<summary>
|
|
<p>In the default DMO streaming model, buffers are managed through the <strong><see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/></strong> interface. The client of the DMO is responsible for implementing an object that exposes this interface. The <strong><see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/></strong> interface has three methods:</p><ul> <li><strong>GetBufferAndLength</strong> returns the address of the buffer (that is, the actual block of memory that holds the data) and the size of any valid data in the buffer.</li> <li><strong>GetMaxLength</strong> returns the size of the buffer.</li> <li><strong>SetLength</strong> specifies the length of the valid data in the buffer.</li> </ul><p>In-place processing does not require the <strong><see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/></strong> interface. The following code shows a minimal implementation of <strong><see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/></strong>:</p><pre><code> // CMediaBuffer class.
|
|
#include <dmo.h>
|
|
class CMediaBuffer : public <see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/>
|
|
{
|
|
private: DWORD m_cbLength; const DWORD m_cbMaxLength; LONG m_nRefCount; // Reference count BYTE *m_pbData; CMediaBuffer(DWORD cbMaxLength, <see cref="T:SharpDX.Result"/>& hr) : m_nRefCount(1), m_cbMaxLength(cbMaxLength), m_cbLength(0), m_pbData(<c>null</c>) { m_pbData = new BYTE[cbMaxLength]; if (!m_pbData) { hr = E_OUTOFMEMORY; } } ~CMediaBuffer() { if (m_pbData) { delete [] m_pbData; } } public: // Function to create a new <see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/> object and return // an AddRef'd interface reference. static <see cref="T:SharpDX.Result"/> Create(long cbMaxLen, <see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/> **ppBuffer) { <see cref="T:SharpDX.Result"/> hr = <see cref="F:SharpDX.Result.Ok"/>; CMediaBuffer *pBuffer = <c>null</c>; if (ppBuffer == <c>null</c>) { return E_POINTER; } pBuffer = new CMediaBuffer(cbMaxLen, hr); if (pBuffer == <c>null</c>) { hr = E_OUTOFMEMORY; } if (SUCCEEDED(hr)) { *ppBuffer = pBuffer; (*ppBuffer)->AddRef(); } if (pBuffer) { pBuffer->Release(); } return hr; } // <see cref="T:SharpDX.ComObject"/> methods. STDMETHODIMP QueryInterface(REFIID riid, void **ppv) { if (ppv == <c>null</c>) { return E_POINTER; } else if (riid == IID_IMediaBuffer || riid == IID_IUnknown) { *ppv = static_cast<<see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/> *>(this); AddRef(); return <see cref="F:SharpDX.Result.Ok"/>; } else { *ppv = <c>null</c>; return E_NOINTERFACE; } } STDMETHODIMP_(ULONG) AddRef() { return InterlockedIncrement(&m_nRefCount); } STDMETHODIMP_(ULONG) Release() { LONG lRef = InterlockedDecrement(&m_nRefCount); if (lRef == 0) { delete this; // m_cRef is no longer valid! Return lRef. } return lRef; } // <see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/> methods. STDMETHODIMP SetLength(DWORD cbLength) { if (cbLength > m_cbMaxLength) { return E_INVALIDARG; } m_cbLength = cbLength; return <see cref="F:SharpDX.Result.Ok"/>; } STDMETHODIMP GetMaxLength(DWORD *pcbMaxLength) { if (pcbMaxLength == <c>null</c>) { return E_POINTER; } *pcbMaxLength = m_cbMaxLength; return <see cref="F:SharpDX.Result.Ok"/>; } STDMETHODIMP GetBufferAndLength(BYTE **ppbBuffer, DWORD *pcbLength) { // Either parameter can be <c>null</c>, but not both. if (ppbBuffer == <c>null</c> && pcbLength == <c>null</c>) { return E_POINTER; } if (ppbBuffer) { *ppbBuffer = m_pbData; } if (pcbLength) { *pcbLength = m_cbLength; } return <see cref="F:SharpDX.Result.Ok"/>; }
|
|
}; </code></pre>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaBuffer']/*"/>
|
|
<msdn-id>dd376684</msdn-id>
|
|
<unmanaged>IMediaBuffer</unmanaged>
|
|
<unmanaged-short>IMediaBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaBuffer.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaBuffer.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.IMediaBuffer">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/>. (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.MediaFoundation.IMediaBuffer.SetLength(System.Int32)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="cbLength">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='IMediaBuffer::SetLength']/*"/>
|
|
<unmanaged>HRESULT IMediaBuffer::SetLength([In] unsigned int cbLength)</unmanaged>
|
|
<unmanaged-short>IMediaBuffer::SetLength</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaBuffer.GetMaxLength(System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="cbMaxLengthRef">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='IMediaBuffer::GetMaxLength']/*"/>
|
|
<unmanaged>HRESULT IMediaBuffer::GetMaxLength([Out] unsigned int* pcbMaxLength)</unmanaged>
|
|
<unmanaged-short>IMediaBuffer::GetMaxLength</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaBuffer.GetBufferAndLength(System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code>GetBufferAndLength</code> method retrieves the buffer and the size of the valid data in the buffer.</p>
|
|
</summary>
|
|
<param name="bufferOut"><dd> <p>Address of a reference that receives the buffer array. Can be <strong><c>null</c></strong> if <em>pcbLength</em> is not <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="cbLengthRef"><dd> <p>Pointer to a variable that receives the size of the valid data, in bytes. Can be <strong><c>null</c></strong> if <em>ppBuffer</em> is not <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>E_POINTER</strong></dt> </dl> </td><td> <p><strong><c>null</c></strong> reference argument</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Either parameter can be <strong><c>null</c></strong>, in which case it does not receive a value. At least one parameter must be non-<strong><c>null</c></strong>. If both parameters are <strong><c>null</c></strong>, the method returns E_POINTER.</p><p>The value returned in the <em>pcbLength</em> parameter is the size of the valid data in the buffer, not the buffer's allocated size. To obtain the buffer's allocated size, call the <strong><see cref="M:SharpDX.MediaFoundation.IMediaBuffer.GetMaxLength(System.Int32@)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaBuffer::GetBufferAndLength']/*"/>
|
|
<msdn-id>dd390167</msdn-id>
|
|
<unmanaged>HRESULT IMediaBuffer::GetBufferAndLength([Out, Buffer, Optional] unsigned char** ppBuffer,[Out, Optional] unsigned int* pcbLength)</unmanaged>
|
|
<unmanaged-short>IMediaBuffer::GetBufferAndLength</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.IMediaBuffer.Length">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaBuffer::SetLength']/*"/>
|
|
<unmanaged>SetLength</unmanaged>
|
|
<unmanaged-short>SetLength</unmanaged-short>
|
|
<unmanaged>HRESULT IMediaBuffer::SetLength([In] unsigned int cbLength)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.IMediaBuffer.MaxLength">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaBuffer::GetMaxLength']/*"/>
|
|
<unmanaged>GetMaxLength</unmanaged>
|
|
<unmanaged-short>GetMaxLength</unmanaged-short>
|
|
<unmanaged>HRESULT IMediaBuffer::GetMaxLength([Out] unsigned int* pcbMaxLength)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.IMediaObject">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code><see cref="T:SharpDX.MediaFoundation.IMediaObject"/></code> interface provides methods for manipulating a Microsoft DirectX Media Object (DMO).</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObject']/*"/>
|
|
<msdn-id>dd406926</msdn-id>
|
|
<unmanaged>IMediaObject</unmanaged>
|
|
<unmanaged-short>IMediaObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.IMediaObject"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.IMediaObject">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.IMediaObject"/>. (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.MediaFoundation.IMediaObject.GetStreamCount(System.Int32@,System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="cInputStreamsRef">No documentation.</param>
|
|
<param name="cOutputStreamsRef">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='IMediaObject::GetStreamCount']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::GetStreamCount([Out] unsigned int* pcInputStreams,[Out] unsigned int* pcOutputStreams)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetStreamCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.GetInputStreamInfo(System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code>GetInputStreamInfo</code> method retrieves information about an input stream, such as any restrictions on the number of samples per buffer, and whether the stream performs lookahead on the input data. This information never changes.</p>
|
|
</summary>
|
|
<param name="dwInputStreamIndex"><dd> <p>Zero-based index of an input stream on the DMO.</p> </dd></param>
|
|
<param name="dwFlagsRef"><dd> <p>Pointer to a variable that receives a bitwise combination of zero or more <strong>DMO_INPUT_STREAM_INFO_FLAGS</strong> flags.</p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>DMO_E_INVALIDSTREAMINDEX</strong></dt> </dl> </td><td> <p>Invalid stream index</p> </td></tr> <tr><td> <dl> <dt><strong>E_POINTER</strong></dt> </dl> </td><td> <p><strong><c>null</c></strong> reference argument</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <see cref="F:SharpDX.MediaFoundation.DmoInputStreamInformationFlags.DmoInputStreamfHoldsBuffers"/> flag indicates that the DMO performs lookahead on the incoming data.</p><p>The application must be sure to allocate sufficient buffers for the DMO to process the input. Call the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.GetInputSizeInfo(System.Int32,System.Int32@,System.Int32@,System.Int32@)"/></strong> method to determine the buffer requirements.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObject::GetInputStreamInfo']/*"/>
|
|
<msdn-id>dd406951</msdn-id>
|
|
<unmanaged>HRESULT IMediaObject::GetInputStreamInfo([In] unsigned int dwInputStreamIndex,[Out] unsigned int* pdwFlags)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetInputStreamInfo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.GetOutputStreamInfo(System.Int32,System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwOutputStreamIndex">No documentation.</param>
|
|
<param name="dwFlagsRef">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='IMediaObject::GetOutputStreamInfo']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::GetOutputStreamInfo([In] unsigned int dwOutputStreamIndex,[Out] unsigned int* pdwFlags)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetOutputStreamInfo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.GetInputType(System.Int32,System.Int32,SharpDX.MediaFoundation.DmoMediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code>GetInputType</code> method retrieves a preferred media type for a specified input stream.</p>
|
|
</summary>
|
|
<param name="dwInputStreamIndex"><dd> <p>Zero-based index of an input stream on the DMO.</p> </dd></param>
|
|
<param name="dwTypeIndex"><dd> <p>Zero-based index on the set of acceptable media types.</p> </dd></param>
|
|
<param name="mtRef"><dd> <p>Pointer to a <strong><see cref="T:SharpDX.MediaFoundation.DmoMediaType"/></strong> structure allocated by the caller, or <strong><c>null</c></strong>. If this parameter is non-<strong><c>null</c></strong>, the method fills the structure with the media type. You can use the value <strong><c>null</c></strong> to test whether the type index is in range, by checking the return code.</p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>DMO_E_INVALIDSTREAMINDEX</strong></dt> </dl> </td><td> <p>Invalid stream index.</p> </td></tr> <tr><td> <dl> <dt><strong>DMO_E_NO_MORE_ITEMS</strong></dt> </dl> </td><td> <p>Type index is out of range.</p> </td></tr> <tr><td> <dl> <dt><strong>E_OUTOFMEMORY</strong></dt> </dl> </td><td> <p>Insufficient memory.</p> </td></tr> <tr><td> <dl> <dt><strong>E_POINTER</strong></dt> </dl> </td><td> <p><strong><c>null</c></strong> reference argument.</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method to enumerate an input stream's preferred media types. The DMO assigns each media type an index value in order of preference. The most preferred type has an index of zero. To enumerate all the types, make successive calls while incrementing the type index until the method returns DMO_E_NO_MORE_ITEMS. The DMO is not guaranteed to enumerate every media type that it supports.</p><p>The format block in the returned type might be <strong><c>null</c></strong>. If so, the format type is GUID_NULL. Check the format type before dereferencing the format block.</p><p>If the method succeeds, call <strong>MoFreeMediaType</strong> to free the format block. (This function is also safe to call when the format block is <strong><c>null</c></strong>.)</p><p>To set the media type, call the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.SetInputType(System.Int32,System.Nullable{SharpDX.MediaFoundation.DmoMediaType},System.Int32)"/></strong> method. Setting the media type on one stream can change another stream's preferred types. In fact, a stream might not have a preferred type until the type is set on another stream. For example, a decoder might not have a preferred output type until the input type is set. However, the DMO is not required to update its preferred types dynamically in this fashion. Thus, the types returned by this method are not guaranteed to be valid; they might fail when used in the <strong>SetInputType</strong> method.</p><p>To test whether a particular media type is acceptable, call <strong>SetInputType</strong> with the <see cref="F:SharpDX.MediaFoundation.DmoSetTypeFlags.DmoSetTypefTestOnly"/> flag.</p><p>To test whether the <em>dwTypeIndex</em> parameter is in range, set <em>pmt</em> to <strong><c>null</c></strong>. The method returns <see cref="F:SharpDX.Result.Ok"/> if the index is in range, or DMO_E_NO_MORE_ITEMS if the index is out of range.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObject::GetInputType']/*"/>
|
|
<msdn-id>dd406952</msdn-id>
|
|
<unmanaged>HRESULT IMediaObject::GetInputType([In] unsigned int dwInputStreamIndex,[In] unsigned int dwTypeIndex,[Out, Optional] DMO_MEDIA_TYPE* pmt)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetInputType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.GetOutputType(System.Int32,System.Int32,SharpDX.MediaFoundation.DmoMediaType@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwOutputStreamIndex">No documentation.</param>
|
|
<param name="dwTypeIndex">No documentation.</param>
|
|
<param name="mtRef">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='IMediaObject::GetOutputType']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::GetOutputType([In] unsigned int dwOutputStreamIndex,[In] unsigned int dwTypeIndex,[Out, Optional] DMO_MEDIA_TYPE* pmt)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetOutputType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.SetInputType(System.Int32,System.Nullable{SharpDX.MediaFoundation.DmoMediaType},System.Int32)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwInputStreamIndex">No documentation.</param>
|
|
<param name="mtRef">No documentation.</param>
|
|
<param name="dwFlags">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='IMediaObject::SetInputType']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::SetInputType([In] unsigned int dwInputStreamIndex,[In, Optional] const DMO_MEDIA_TYPE* pmt,[In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IMediaObject::SetInputType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.SetOutputType(System.Int32,System.Nullable{SharpDX.MediaFoundation.DmoMediaType},System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code>SetOutputType</code> method sets the media type on an output stream, or tests whether a media type is acceptable.</p>
|
|
</summary>
|
|
<param name="dwOutputStreamIndex"><dd> <p>Zero-based index of an output stream on the DMO.</p> </dd></param>
|
|
<param name="mtRef"><dd> <p>Pointer to a <strong><see cref="T:SharpDX.MediaFoundation.DmoMediaType"/></strong> structure that specifies the media type.</p> </dd></param>
|
|
<param name="dwFlags"><dd> <p>Bitwise combination of zero or more flags from the <strong>DMO_SET_TYPE_FLAGS</strong> enumeration.</p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>DMO_E_INVALIDSTREAMINDEX</strong></dt> </dl> </td><td> <p>Invalid stream index</p> </td></tr> <tr><td> <dl> <dt><strong>DMO_E_TYPE_NOT_ACCEPTED</strong></dt> </dl> </td><td> <p>Media type was not accepted</p> </td></tr> <tr><td> <dl> <dt><strong>S_FALSE</strong></dt> </dl> </td><td> <p>Media type is not acceptable</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Media type was set successfully, or is acceptable</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method to test, set, or clear the media type on an output stream:</p><ul> <li>To test the media type without setting it, use the <see cref="F:SharpDX.MediaFoundation.DmoSetTypeFlags.DmoSetTypefTestOnly"/> flag. If the media type is not acceptable, the method returns S_FALSE.</li> <li>To set the media type, set <em>dwFlags</em> to zero. If the media type is not acceptable, the method returns DMO_E_TYPE_NOT_ACCEPTED.</li> <li>To clear the current media type (if any), use the <see cref="F:SharpDX.MediaFoundation.DmoSetTypeFlags.DmoSetTypefClear"/> flag and set <em>pmt</em> to <strong><c>null</c></strong>. When the method returns, the stream no longer has a media type. The DMO cannot process samples until the application sets a new media type, unless the stream is optional.</li> </ul><p>The media types that are currently set on other streams can affect whether the media type is acceptable.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObject::SetOutputType']/*"/>
|
|
<msdn-id>dd406963</msdn-id>
|
|
<unmanaged>HRESULT IMediaObject::SetOutputType([In] unsigned int dwOutputStreamIndex,[In, Optional] const DMO_MEDIA_TYPE* pmt,[In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IMediaObject::SetOutputType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.GetInputCurrentType(System.Int32,SharpDX.MediaFoundation.DmoMediaType@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwInputStreamIndex">No documentation.</param>
|
|
<param name="mtRef">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='IMediaObject::GetInputCurrentType']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::GetInputCurrentType([In] unsigned int dwInputStreamIndex,[Out] DMO_MEDIA_TYPE* pmt)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetInputCurrentType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.GetOutputCurrentType(System.Int32,SharpDX.MediaFoundation.DmoMediaType@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwOutputStreamIndex">No documentation.</param>
|
|
<param name="mtRef">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='IMediaObject::GetOutputCurrentType']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::GetOutputCurrentType([In] unsigned int dwOutputStreamIndex,[Out] DMO_MEDIA_TYPE* pmt)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetOutputCurrentType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.GetInputSizeInfo(System.Int32,System.Int32@,System.Int32@,System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwInputStreamIndex">No documentation.</param>
|
|
<param name="cbSizeRef">No documentation.</param>
|
|
<param name="cbMaxLookaheadRef">No documentation.</param>
|
|
<param name="cbAlignmentRef">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='IMediaObject::GetInputSizeInfo']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::GetInputSizeInfo([In] unsigned int dwInputStreamIndex,[Out] unsigned int* pcbSize,[Out] unsigned int* pcbMaxLookahead,[Out] unsigned int* pcbAlignment)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetInputSizeInfo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.GetOutputSizeInfo(System.Int32,System.Int32@,System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwOutputStreamIndex">No documentation.</param>
|
|
<param name="cbSizeRef">No documentation.</param>
|
|
<param name="cbAlignmentRef">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='IMediaObject::GetOutputSizeInfo']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::GetOutputSizeInfo([In] unsigned int dwOutputStreamIndex,[Out] unsigned int* pcbSize,[Out] unsigned int* pcbAlignment)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetOutputSizeInfo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.GetInputMaxLatency(System.Int32,System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code>GetInputMaxLatency</code> method retrieves the maximum latency on a specified input stream.</p>
|
|
</summary>
|
|
<param name="dwInputStreamIndex"><dd> <p>Zero-based index of an input stream on the DMO.</p> </dd></param>
|
|
<param name="rtMaxLatencyRef"><dd> <p>Pointer to a variable that receives the maximum latency.</p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>DMO_E_INVALIDSTREAMINDEX</strong></dt> </dl> </td><td> <p>Invalid stream index.</p> </td></tr> <tr><td> <dl> <dt><strong>E_FAIL</strong></dt> </dl> </td><td> <p>Failure.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>Not implemented. Assume zero latency.</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The latency is the difference between a time stamp on the input stream and the corresponding time stamp on the output stream. The maximum latency is the largest possible difference in the time stamps. For a DMO, determine the maximum latency as follows:</p><ul> <li>Process input buffers until the DMO can produce output. </li> <li>Process as many output buffers as possible. </li> <li>The maximum latency is the largest delta between input time stamps and output time stamps (taken as an absolute value). </li> </ul><p>Under this definition, latency does not include the time that it takes to process samples. Nor does it include any latency introduced by the size of the input buffer.</p><p>For the special case where a DMO processes exactly one sample at a time, the maximum latency is simply the difference in time stamps.</p><p>Latency is defined only when samples have time stamps, and the time stamps increase or decrease monotonically. Maximum latency might depend on the media types for the input and output streams.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObject::GetInputMaxLatency']/*"/>
|
|
<msdn-id>dd406948</msdn-id>
|
|
<unmanaged>HRESULT IMediaObject::GetInputMaxLatency([In] unsigned int dwInputStreamIndex,[Out] longlong* prtMaxLatency)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetInputMaxLatency</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.SetInputMaxLatency(System.Int32,System.Int64)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwInputStreamIndex">No documentation.</param>
|
|
<param name="rtMaxLatency">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='IMediaObject::SetInputMaxLatency']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::SetInputMaxLatency([In] unsigned int dwInputStreamIndex,[In] longlong rtMaxLatency)</unmanaged>
|
|
<unmanaged-short>IMediaObject::SetInputMaxLatency</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.Flush">
|
|
<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='IMediaObject::Flush']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::Flush()</unmanaged>
|
|
<unmanaged-short>IMediaObject::Flush</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.Discontinuity(System.Int32)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwInputStreamIndex">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='IMediaObject::Discontinuity']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::Discontinuity([In] unsigned int dwInputStreamIndex)</unmanaged>
|
|
<unmanaged-short>IMediaObject::Discontinuity</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.AllocateStreamingResources">
|
|
<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='IMediaObject::AllocateStreamingResources']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::AllocateStreamingResources()</unmanaged>
|
|
<unmanaged-short>IMediaObject::AllocateStreamingResources</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.FreeStreamingResources">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code>FreeStreamingResources</code> method frees resources allocated by the DMO. Calling this method is always optional.</p>
|
|
</summary>
|
|
<returns><p>Returns <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, returns an <strong><see cref="T:SharpDX.Result"/></strong> value indicating the cause of the error.</p></returns>
|
|
<remarks>
|
|
<p>This method releases any resources that the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.AllocateStreamingResources"/></strong> method initializes.</p><p>If the DMO does not support this method, the method returns <see cref="F:SharpDX.Result.Ok"/>. If you call this method during streaming, the method fails and the DMO does not release any resources.</p><p>Regardless of whether the method fails or succeeds, the application can continue to call other methods on the DMO. The DMO might need to re-initialize resources that were previously freed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObject::FreeStreamingResources']/*"/>
|
|
<msdn-id>dd406946</msdn-id>
|
|
<unmanaged>HRESULT IMediaObject::FreeStreamingResources()</unmanaged>
|
|
<unmanaged-short>IMediaObject::FreeStreamingResources</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.GetInputStatus(System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code>GetInputStatus</code> method queries whether an input stream can accept more input data.</p>
|
|
</summary>
|
|
<param name="dwInputStreamIndex"><dd> <p>Zero-based index of an input stream on the DMO.</p> </dd></param>
|
|
<param name="dwFlags"><dd> <p>Pointer to a variable that receives either zero or <see cref="F:SharpDX.MediaFoundation.DmoInputStatusFlags.DmoInputStatusfAcceptData"/>.</p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>DMO_E_INVALIDSTREAMINDEX</strong></dt> </dl> </td><td> <p>Invalid stream index</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the input stream will accept more data, the method returns the <see cref="F:SharpDX.MediaFoundation.DmoInputStatusFlags.DmoInputStatusfAcceptData"/> flag in the <em>dwFlags</em> parameter. Otherwise, it sets this parameter to zero. If the stream will accept more data, the application can call the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.ProcessInput(System.Int32,SharpDX.MediaFoundation.IMediaBuffer,System.Int32,System.Int64,System.Int64)"/></strong> method.</p><p>The status of an input stream can change only as the result of one of the following method calls.</p><table> <tr><th> Method </th><th> Description </th></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.Discontinuity(System.Int32)"/></strong> </td><td>Signals a discontinuity on the specified input stream.</td></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.Flush"/></strong> </td><td>Flushes all internally buffered data.</td></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.ProcessInput(System.Int32,SharpDX.MediaFoundation.IMediaBuffer,System.Int32,System.Int64,System.Int64)"/></strong> </td><td>Delivers a buffer to the specified input stream.</td></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.DmoOutputDataBuffer[],System.Int32@)"/></strong> </td><td>Generates output from the current input data.</td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObject::GetInputStatus']/*"/>
|
|
<msdn-id>dd406950</msdn-id>
|
|
<unmanaged>HRESULT IMediaObject::GetInputStatus([In] unsigned int dwInputStreamIndex,[Out] unsigned int* dwFlags)</unmanaged>
|
|
<unmanaged-short>IMediaObject::GetInputStatus</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.ProcessInput(System.Int32,SharpDX.MediaFoundation.IMediaBuffer,System.Int32,System.Int64,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code>ProcessInput</code> method delivers a buffer to the specified input stream.</p>
|
|
</summary>
|
|
<param name="dwInputStreamIndex"><dd> <p>Zero-based index of an input stream on the DMO.</p> </dd></param>
|
|
<param name="bufferRef"><dd> <p>Pointer to the buffer's <strong><see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/></strong> interface.</p> </dd></param>
|
|
<param name="dwFlags"><dd> <p>Bitwise combination of zero or more flags from the <strong>DMO_INPUT_DATA_BUFFER_FLAGS</strong> enumeration.</p> </dd></param>
|
|
<param name="rtTimestamp"><dd> <p>Time stamp that specifies the start time of the data in the buffer. If the buffer has a valid time stamp, set the <see cref="F:SharpDX.MediaFoundation.DmoInputDataBufferFlags.DmoInputDataBufferfTime"/> flag in the <em>dwFlags</em> parameter. Otherwise, the DMO ignores this value.</p> </dd></param>
|
|
<param name="rtTimelength"><dd> <p>Reference time specifying the duration of the data in the buffer. If this value is valid, set the <see cref="F:SharpDX.MediaFoundation.DmoInputDataBufferFlags.DmoInputDataBufferfTimelength"/> flag in the <em>dwFlags</em> parameter. Otherwise, the DMO ignores this value.</p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>DMO_E_INVALIDSTREAMINDEX</strong></dt> </dl> </td><td> <p>Invalid stream index.</p> </td></tr> <tr><td> <dl> <dt><strong>DMO_E_NOTACCEPTING</strong></dt> </dl> </td><td> <p>Data cannot be accepted.</p> </td></tr> <tr><td> <dl> <dt><strong>S_FALSE</strong></dt> </dl> </td><td> <p>No output to process.</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The input buffer specified in the <em>pBuffer</em> parameter is read-only. The DMO will not modify the data in this buffer. All write operations occur on the output buffers, which are given in a separate call to the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.DmoOutputDataBuffer[],System.Int32@)"/></strong> method.</p><p>If the DMO does not process all the data in the buffer, it keeps a reference count on the buffer. It releases the buffer once it has generated all the output, unless it needs to perform lookahead on the data. (To determine whether a DMO performs lookahead, call the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.GetInputStreamInfo(System.Int32,System.Int32@)"/></strong> method.)</p><p>If this method returns DMO_E_NOTACCEPTING, call <strong>ProcessOutput</strong> until the input stream can accept more data. To determine whether the stream can accept more data, call the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.GetInputStatus(System.Int32,System.Int32@)"/></strong> method.</p><p>If the method returns S_FALSE, no output was generated from this input and the application does not need to call <strong>ProcessOutput</strong>. However, a DMO is not required to return S_FALSE in this situation; it might return <see cref="F:SharpDX.Result.Ok"/>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObject::ProcessInput']/*"/>
|
|
<msdn-id>dd406959</msdn-id>
|
|
<unmanaged>HRESULT IMediaObject::ProcessInput([In] unsigned int dwInputStreamIndex,[In] IMediaBuffer* pBuffer,[In] unsigned int dwFlags,[In] longlong rtTimestamp,[In] longlong rtTimelength)</unmanaged>
|
|
<unmanaged-short>IMediaObject::ProcessInput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.DmoOutputDataBuffer[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <code>ProcessOutput</code> method generates output from the current input data.</p>
|
|
</summary>
|
|
<param name="dwFlags"><dd> <p>Bitwise combination of zero or more flags from the <strong>DMO_PROCESS_OUTPUT_FLAGS</strong> enumeration.</p> </dd></param>
|
|
<param name="cOutputBufferCount"><dd> <p>Number of output buffers.</p> </dd></param>
|
|
<param name="outputBuffersRef"><dd> <p>Pointer to an array of <strong><see cref="T:SharpDX.MediaFoundation.DmoOutputDataBuffer"/></strong> structures containing the output buffers. Specify the size of the array in the <em>cOutputBufferCount</em> parameter.</p> </dd></param>
|
|
<param name="dwStatusRef"><dd> <p>Pointer to a variable that receives a reserved value (zero). The application should ignore this value.</p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Possible values include those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>E_FAIL</strong></dt> </dl> </td><td> <p>Failure</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid argument</p> </td></tr> <tr><td> <dl> <dt><strong>E_POINTER</strong></dt> </dl> </td><td> <p><strong><c>null</c></strong> reference argument</p> </td></tr> <tr><td> <dl> <dt><strong>S_FALSE</strong></dt> </dl> </td><td> <p>No output was generated</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <em>pOutputBuffers</em> parameter points to an array of <strong><see cref="T:SharpDX.MediaFoundation.DmoOutputDataBuffer"/></strong> structures. The application must allocate one structure for each output stream. To determine the number of output streams, call the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.GetStreamCount(System.Int32@,System.Int32@)"/></strong> method. Set the <em>cOutputBufferCount</em> parameter to this number.</p><p>Each <strong><see cref="T:SharpDX.MediaFoundation.DmoOutputDataBuffer"/></strong> structure contains a reference to a buffer's <strong><see cref="T:SharpDX.MediaFoundation.IMediaBuffer"/></strong> interface. The application allocates these buffers. The other members of the structure are status fields. The DMO sets these fields if the method succeeds. If the method fails, their values are undefined.</p><p>When the application calls <code>ProcessOutput</code>, the DMO processes as much input data as possible. It writes the output data to the output buffers, starting from the end of the data in each buffer. (To find the end of the data, call the <strong><see cref="M:SharpDX.MediaFoundation.IMediaBuffer.GetBufferAndLength(System.Byte[],System.Int32@)"/></strong> method.) The DMO never holds a reference count on an output buffer.</p><p>If the DMO fills an entire output buffer and still has input data to process, the DMO returns the <see cref="F:SharpDX.MediaFoundation.DmoOutputDataBufferFlags.DmoOutputDataBufferfIncomplete"/> flag in the <strong><see cref="T:SharpDX.MediaFoundation.DmoOutputDataBuffer"/></strong> structure. The application should check for this flag by testing the <strong>dwStatus</strong> member of each structure.</p><p>If the method returns S_FALSE, no output was generated. However, a DMO is not required to return S_FALSE in this situation; it might return <see cref="F:SharpDX.Result.Ok"/>.</p><p><strong>Discarding data:</strong></p><p>You can discard data from a stream by setting the <see cref="F:SharpDX.MediaFoundation.DmoProcessOutputFlags.DmoProcessOutputDiscardWhenNoBuffer"/> flag in the <em>dwFlags</em> parameter. For each stream that you want to discard, set the <strong>pBuffer</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.DmoOutputDataBuffer"/></strong> structure to <strong><c>null</c></strong>.</p><p>For each stream in which <strong>pBuffer</strong> is <strong><c>null</c></strong>:</p><ul> <li>If the <see cref="F:SharpDX.MediaFoundation.DmoProcessOutputFlags.DmoProcessOutputDiscardWhenNoBuffer"/> flag is set, and the stream is discardable or optional, the DMO discards the data.</li> <li>If the flag is set but the stream is neither discardable nor optional, the DMO discards the data if possible. It is not guaranteed to discard the data.</li> <li>If the flag is not set, the DMO does not produce output data for that stream, but does not discard the data.</li> </ul><p>To check whether a stream is discardable or optional, call the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.GetOutputStreamInfo(System.Int32,System.Int32@)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObject::ProcessOutput']/*"/>
|
|
<msdn-id>dd406960</msdn-id>
|
|
<unmanaged>HRESULT IMediaObject::ProcessOutput([In] unsigned int dwFlags,[In] unsigned int cOutputBufferCount,[Out, Buffer] DMO_OUTPUT_DATA_BUFFER* pOutputBuffers,[Out] unsigned int* pdwStatus)</unmanaged>
|
|
<unmanaged-short>IMediaObject::ProcessOutput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObject.Lock(System.Int32)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="bLock">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='IMediaObject::Lock']/*"/>
|
|
<unmanaged>HRESULT IMediaObject::Lock([In] int bLock)</unmanaged>
|
|
<unmanaged-short>IMediaObject::Lock</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.IMediaObjectInPlace">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObjectInPlace']/*"/>
|
|
<unmanaged>IMediaObjectInPlace</unmanaged>
|
|
<unmanaged-short>IMediaObjectInPlace</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObjectInPlace.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.IMediaObjectInPlace"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObjectInPlace.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.IMediaObjectInPlace">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.IMediaObjectInPlace"/>. (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.MediaFoundation.IMediaObjectInPlace.Process(System.Int32,System.Byte[],System.Int64,System.Int32)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="ulSize">No documentation.</param>
|
|
<param name="dataRef">No documentation.</param>
|
|
<param name="refTimeStart">No documentation.</param>
|
|
<param name="dwFlags">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='IMediaObjectInPlace::Process']/*"/>
|
|
<unmanaged>HRESULT IMediaObjectInPlace::Process([In] unsigned int ulSize,[Out, Buffer] unsigned char* pData,[In] longlong refTimeStart,[In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IMediaObjectInPlace::Process</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObjectInPlace.Clone(SharpDX.MediaFoundation.IMediaObjectInPlace@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="mediaObjectOut">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='IMediaObjectInPlace::Clone']/*"/>
|
|
<unmanaged>HRESULT IMediaObjectInPlace::Clone([Out] IMediaObjectInPlace** ppMediaObject)</unmanaged>
|
|
<unmanaged-short>IMediaObjectInPlace::Clone</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.IMediaObjectInPlace.GetLatency(System.Int64@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="latencyTimeRef">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='IMediaObjectInPlace::GetLatency']/*"/>
|
|
<unmanaged>HRESULT IMediaObjectInPlace::GetLatency([Out] longlong* pLatencyTime)</unmanaged>
|
|
<unmanaged-short>IMediaObjectInPlace::GetLatency</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.IMediaObjectInPlace.Latency">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMediaObjectInPlace::GetLatency']/*"/>
|
|
<unmanaged>GetLatency</unmanaged>
|
|
<unmanaged-short>GetLatency</unmanaged-short>
|
|
<unmanaged>HRESULT IMediaObjectInPlace::GetLatency([Out] longlong* pLatencyTime)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.InputTrustAuthority">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Requests permission to perform a specified action on the stream.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method verifies whether the user has permission to perform a specified action on the stream. The ITA does any work needed to verify the user's right to perform the action, such as checking licenses.</p><p>To verify the user's rights, the ITA might need to perform additional steps that require interaction with the user or consent from the user. For example, it might need to acquire a new license or individualize a DRM component. In that case, the ITA creates an activation object for a content enabler and returns the activation object's <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface in the <em>ppContentEnablerActivate</em> parameter. The activation object is responsible for creating a content enabler that exposes the <strong><see cref="T:SharpDX.MediaFoundation.ContentEnabler"/></strong> interface. The content enabler is used as follows:</p><ol> <li> <p>The Media Session returns the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> reference to the application.</p> </li> <li> <p>The application calls <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> to activate the content enabler.</p> </li> <li> <p>The application calls <strong><see cref="T:SharpDX.MediaFoundation.ContentEnabler"/></strong> methods to perform whatever actions are needed, such as individualization or obtaining a license. The content enabler object must encapsulate this functionality through the <strong><see cref="T:SharpDX.MediaFoundation.ContentEnabler"/></strong> interface.</p> </li> <li> <p>The Media Session calls <strong>RequestAccess</strong> again.</p> </li> </ol><p>The return value signals whether the user has permission to perform the action:</p><ul> <li> <p>If the user already has permission to perform the action, the method returns <see cref="F:SharpDX.Result.Ok"/> and sets *<em>ppContentEnablerActivate</em> to <strong><c>null</c></strong>.</p> </li> <li> <p>If the user does not have permission, the method returns a failure code and sets *<em>ppContentEnablerActivate</em> to <strong><c>null</c></strong>.</p> </li> <li> <p>If the ITA must perform additional steps that require interaction with the user, the method returns a failure code and returns the content enabler's <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> reference in <em>ppContentEnablerActivate</em>.</p> </li> </ul><p>The Media Session will not allow the action unless this method returns <see cref="F:SharpDX.Result.Ok"/>. However, a return value of <see cref="F:SharpDX.Result.Ok"/> does not guarantee that the action will be performed, because some other failure might occur after this method is called. When the action is definitely about to happen, the Media Session calls <strong><see cref="M:SharpDX.MediaFoundation.InputTrustAuthority.BindAccess(SharpDX.MediaFoundation.InputtrustauthorityAccessParams@)"/></strong>.</p><p>A stream can go to multiple outputs, so this method might be called multiple times with different actions, once for every output.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFInputTrustAuthority']/*"/>
|
|
<msdn-id>bb970453</msdn-id>
|
|
<unmanaged>IMFInputTrustAuthority</unmanaged>
|
|
<unmanaged-short>IMFInputTrustAuthority</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.InputTrustAuthority.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.InputTrustAuthority"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.InputTrustAuthority.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.InputTrustAuthority">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.InputTrustAuthority"/>. (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.MediaFoundation.InputTrustAuthority.GetDecrypter(System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a decrypter transform.</p>
|
|
</summary>
|
|
<param name="riid"><dd> <p>Interface identifier (IID) of the interface being requested. Currently this value must be IID_IMFTransform, which requests the <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> interface.</p> </dd></param>
|
|
<param name="vOut"><dd> <p>Receives a reference to the interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOINTERFACE</strong></dt> </dl> </td><td> <p>The decrypter does not support the requested interface.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_PROTECTED</strong></dt> </dl> </td><td> <p>This input trust authority (ITA) does not provide a decrypter.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The decrypter should be created in a disabled state, where any calls to <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong> automatically fail. After the input trust authority (ITA) has verified that it is running inside the protected media path (PMP), the ITA should enable the decrypter.</p><p>An ITA is not required to provide a decrypter. If the source content is not encrypted, the method should return MF_E_NOT_PROTECTED. The PMP will then proceed without using a decrypter for that stream.</p><p>The ITA must create a new instance of its decrypter for each call to <strong>GetDecrypter</strong>. Do not return multiple references to the same decrypter. They must be separate instances because the Media Session might place them in two different branches of the topology.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFInputTrustAuthority::GetDecrypter']/*"/>
|
|
<msdn-id>bb970385</msdn-id>
|
|
<unmanaged>HRESULT IMFInputTrustAuthority::GetDecrypter([In] const GUID& riid,[Out] void** ppv)</unmanaged>
|
|
<unmanaged-short>IMFInputTrustAuthority::GetDecrypter</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.InputTrustAuthority.RequestAccess(SharpDX.MediaFoundation.PolicymanagerAction,SharpDX.MediaFoundation.Activate@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="action">No documentation.</param>
|
|
<param name="contentEnablerActivateOut">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='IMFInputTrustAuthority::RequestAccess']/*"/>
|
|
<unmanaged>HRESULT IMFInputTrustAuthority::RequestAccess([In] MFPOLICYMANAGER_ACTION Action,[Out] IMFActivate** ppContentEnablerActivate)</unmanaged>
|
|
<unmanaged-short>IMFInputTrustAuthority::RequestAccess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.InputTrustAuthority.GetPolicy(SharpDX.MediaFoundation.PolicymanagerAction,SharpDX.MediaFoundation.OutputPolicy@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the policy that defines which output protection systems are allowed for this stream, and the configuration data for each protection system.</p>
|
|
</summary>
|
|
<param name="action"><dd> <p>The action that will be performed on this stream, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.PolicymanagerAction"/></strong> enumeration.</p> </dd></param>
|
|
<param name="policyOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.OutputPolicy"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFInputTrustAuthority::GetPolicy']/*"/>
|
|
<msdn-id>bb970400</msdn-id>
|
|
<unmanaged>HRESULT IMFInputTrustAuthority::GetPolicy([In] MFPOLICYMANAGER_ACTION Action,[Out] IMFOutputPolicy** ppPolicy)</unmanaged>
|
|
<unmanaged-short>IMFInputTrustAuthority::GetPolicy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.InputTrustAuthority.BindAccess(SharpDX.MediaFoundation.InputtrustauthorityAccessParams@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Notifies the input trust authority (ITA) that a requested action is about to be performed.</p>
|
|
</summary>
|
|
<param name="paramRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.InputtrustauthorityAccessParams"/></strong> structure that contains parameters for the <strong>BindAccess</strong> action.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Before calling this method, the Media Session calls <strong><see cref="M:SharpDX.MediaFoundation.InputTrustAuthority.RequestAccess(SharpDX.MediaFoundation.PolicymanagerAction,SharpDX.MediaFoundation.Activate@)"/></strong> to request an action. The <strong>BindAccess</strong> method notifies the ITA that the action is definitely about to occur, so that the ITA can update its internal state as needed. If the method returns a failure code, the Media Session cancels the action.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFInputTrustAuthority::BindAccess']/*"/>
|
|
<msdn-id>ms701551</msdn-id>
|
|
<unmanaged>HRESULT IMFInputTrustAuthority::BindAccess([In] MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS* pParam)</unmanaged>
|
|
<unmanaged-short>IMFInputTrustAuthority::BindAccess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.InputTrustAuthority.UpdateAccess(SharpDX.MediaFoundation.InputtrustauthorityAccessParams@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Notifies the input trust authority (ITA) when the number of output trust authorities (OTAs) that will perform a specified action has changed.</p>
|
|
</summary>
|
|
<param name="paramRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.InputtrustauthorityAccessParams"/></strong> structure that contains parameters for the <strong>UpdateAccess</strong> action.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The ITA can update its internal state if needed. If the method returns a failure code, the Media Session cancels the action.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFInputTrustAuthority::UpdateAccess']/*"/>
|
|
<msdn-id>ms697037</msdn-id>
|
|
<unmanaged>HRESULT IMFInputTrustAuthority::UpdateAccess([In] MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS* pParam)</unmanaged>
|
|
<unmanaged-short>IMFInputTrustAuthority::UpdateAccess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.InputTrustAuthority.Reset">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Resets the input trust authority (ITA) to its initial state.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When this method is called, the ITA should disable any decrypter that was returned in the <strong><see cref="M:SharpDX.MediaFoundation.InputTrustAuthority.GetDecrypter(System.Guid,System.IntPtr@)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFInputTrustAuthority::Reset']/*"/>
|
|
<msdn-id>ms703015</msdn-id>
|
|
<unmanaged>HRESULT IMFInputTrustAuthority::Reset()</unmanaged>
|
|
<unmanaged-short>IMFInputTrustAuthority::Reset</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.LocalMFTRegistration">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Registers one or more Media Foundation transforms (MFTs) in the caller's process.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method is similar to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocalByCLSID(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong> function. It registers one or more MFTs in the caller's process. These MFTs can be enumerated by calling the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> function with the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsLocalmft"/></strong> flag.</p><p>Unlike <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocalByCLSID(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong>, however, this method also makes the MFT available in the Protected Media Path (PMP) process, and is therefore useful if you are using the Media Session inside the PMP. For more information, see the following topics:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong> </li> <li> Protected Media Path </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFLocalMFTRegistration']/*"/>
|
|
<msdn-id>dd374223</msdn-id>
|
|
<unmanaged>IMFLocalMFTRegistration</unmanaged>
|
|
<unmanaged-short>IMFLocalMFTRegistration</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.LocalMFTRegistration.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.LocalMFTRegistration"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.LocalMFTRegistration.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.LocalMFTRegistration">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.LocalMFTRegistration"/>. (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.MediaFoundation.LocalMFTRegistration.RegisterMFTs(SharpDX.MediaFoundation.TRegistrationInformation[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Registers one or more Media Foundation transforms (MFTs) in the caller's process.</p>
|
|
</summary>
|
|
<param name="mFTsRef"><dd> <p>A reference to an array of <strong><see cref="T:SharpDX.MediaFoundation.TRegistrationInformation"/></strong> structures.</p> </dd></param>
|
|
<param name="cMFTs"><dd> <p>The number of elements in the <em>pMFTs</em> array.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This method is similar to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocalByCLSID(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong> function. It registers one or more MFTs in the caller's process. These MFTs can be enumerated by calling the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> function with the <strong><see cref="F:SharpDX.MediaFoundation.MftEnumFlags.MftEnumFlagsLocalmft"/></strong> flag.</p><p>Unlike <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TRegisterLocalByCLSID(System.Guid,System.Guid,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32,SharpDX.MediaFoundation.TRegisterTypeInformation[])"/></strong>, however, this method also makes the MFT available in the Protected Media Path (PMP) process, and is therefore useful if you are using the Media Session inside the PMP. For more information, see the following topics:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong> </li> <li> Protected Media Path </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFLocalMFTRegistration::RegisterMFTs']/*"/>
|
|
<msdn-id>dd374223</msdn-id>
|
|
<unmanaged>HRESULT IMFLocalMFTRegistration::RegisterMFTs([In, Buffer] MFT_REGISTRATION_INFO* pMFTs,[In] unsigned int cMFTs)</unmanaged>
|
|
<unmanaged-short>IMFLocalMFTRegistration::RegisterMFTs</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaBuffer">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Represents a block of memory that contains media data. Use this interface to access the data in the buffer.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the buffer contains 2-D image data (such as an uncompressed video frame), you should query the buffer for the <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> interface. The methods on <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> are optimized for 2-D data.</p><p>To get a buffer from a media sample, call one of the following <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> methods:</p><ul> <li> <p> <strong><see cref="M:SharpDX.MediaFoundation.Sample.ConvertToContiguousBuffer(SharpDX.MediaFoundation.MediaBuffer@)"/></strong> </p> </li> <li> <p> <strong><see cref="M:SharpDX.MediaFoundation.Sample.GetBufferByIndex(System.Int32,SharpDX.MediaFoundation.MediaBuffer@)"/></strong> </p> </li> </ul><p>To create a new buffer object, use one of the following functions.</p><table> <tr><th>Function</th><th>Description</th></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMemoryBuffer(System.Int32,SharpDX.MediaFoundation.MediaBuffer@)"/></strong> </td><td>Creates a buffer and allocates system memory.</td></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaBufferWrapper(SharpDX.MediaFoundation.MediaBuffer,System.Int32,System.Int32,SharpDX.MediaFoundation.MediaBuffer@)"/></strong> </td><td>Creates a media buffer that wraps an existing media buffer.</td></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateDXSurfaceBuffer(System.Guid,SharpDX.ComObject,System.Boolean,SharpDX.MediaFoundation.MediaBuffer@)"/></strong> </td><td>Creates a buffer that manages a DirectX surface.</td></tr> <tr><td> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAlignedMemoryBuffer(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaBuffer@)"/></strong> </td><td>Creates a buffer and allocates system memory with a specified alignment.</td></tr> </table><p>?</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaBuffer']/*"/>
|
|
<msdn-id>ms696261</msdn-id>
|
|
<unmanaged>IMFMediaBuffer</unmanaged>
|
|
<unmanaged-short>IMFMediaBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaBuffer.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaBuffer"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaBuffer.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaBuffer">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaBuffer"/>. (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.MediaFoundation.MediaBuffer.Lock(System.Byte[],System.Int32@,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gives the caller access to the memory in the buffer, for reading or writing</p>
|
|
</summary>
|
|
<param name="bBufferOut"><dd> <p>Receives a reference to the start of the buffer.</p> </dd></param>
|
|
<param name="cbMaxLengthRef"><dd> <p>Receives the maximum amount of data that can be written to the buffer. This parameter can be <strong><c>null</c></strong>. The same value is returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetMaxLength(System.Int32@)"/></strong> method.</p> </dd></param>
|
|
<param name="cbCurrentLengthRef"><dd> <p>Receives the length of the valid data in the buffer, in bytes. This parameter can be <strong><c>null</c></strong>. The same value is returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetCurrentLength(System.Int32@)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>D3DERR_INVALIDCALL</strong></dt> </dl> </td><td> <p>For Direct3D surface buffers, an error occurred when locking the surface.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The buffer cannot be locked at this time.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method gives the caller access to the entire buffer, up to the maximum size returned in the <em>pcbMaxLength</em> parameter. The value returned in <em>pcbCurrentLength</em> is the size of any valid data already in the buffer, which might be less than the total buffer size.</p><p>The reference returned in <em>ppbBuffer</em> is guaranteed to be valid, and can safely be accessed across the entire buffer for as long as the lock is held. When you are done accessing the buffer, call <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.Unlock"/></strong> to unlock the buffer. You must call <strong>Unlock</strong> once for each call to <strong>Lock</strong>. After you unlock the buffer, the reference returned in <em>ppbBuffer</em> is no longer valid, and should not be used. Generally, it is best to call <strong>Lock</strong> only when you need to access the buffer memory, and not earlier.</p><p>Locking the buffer does not prevent other threads from calling <strong>Lock</strong>, so you should not rely on this method to synchronize threads.</p><p>This method does not allocate any memory, or transfer ownership of the memory to the caller. Do not release or free the memory; the media buffer will free the memory when the media buffer is destroyed.</p><p>If you modify the contents of the buffer, update the current length by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.SetCurrentLength(System.Int32)"/></strong>.</p><p>If the buffer supports the <strong><see cref="T:SharpDX.MediaFoundation.Buffer2D"/></strong> interface, you should use the <strong><see cref="M:SharpDX.MediaFoundation.Buffer2D.Lock2D(System.Byte[],System.Int32@)"/></strong> method to lock the buffer. For 2-D buffers, the <strong>Lock2D</strong> method is more efficient than the <strong>Lock</strong> method. If the buffer is locked using <strong>Lock2D</strong>, the Lock method might return <strong>MF_E_INVALIDREQUEST</strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaBuffer::Lock']/*"/>
|
|
<msdn-id>bb970366</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaBuffer::Lock([Out, Buffer] unsigned char** ppbBuffer,[Out, Optional] unsigned int* pcbMaxLength,[Out, Optional] unsigned int* pcbCurrentLength)</unmanaged>
|
|
<unmanaged-short>IMFMediaBuffer::Lock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaBuffer.Unlock">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Unlocks a buffer that was previously locked. Call this method once for every call to <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.Lock(System.Byte[],System.Int32@,System.Int32@)"/></strong>.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>D3DERR_INVALIDCALL</strong></dt> </dl> </td><td> <p>For Direct3D surface buffers, an error occurred when unlocking the surface.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>It is an error to call <strong>Unlock</strong> if you did not call <strong>Lock</strong> previously.</p><p>After calling this method, do not use the reference returned by the <strong>Lock</strong> method. It is no longer guaranteed to be valid.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaBuffer::Unlock']/*"/>
|
|
<msdn-id>ms696259</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaBuffer::Unlock()</unmanaged>
|
|
<unmanaged-short>IMFMediaBuffer::Unlock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaBuffer.GetCurrentLength(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the length of the valid data in the buffer.</p>
|
|
</summary>
|
|
<param name="cbCurrentLengthRef"><dd> <p>Receives the length of the valid data, in bytes. If the buffer does not contain any valid data, the value is zero.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaBuffer::GetCurrentLength']/*"/>
|
|
<msdn-id>ms698987</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaBuffer::GetCurrentLength([Out] unsigned int* pcbCurrentLength)</unmanaged>
|
|
<unmanaged-short>IMFMediaBuffer::GetCurrentLength</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaBuffer.SetCurrentLength(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the length of the valid data in the buffer.</p>
|
|
</summary>
|
|
<param name="cbCurrentLength"><dd> <p>Length of the valid data, in bytes. This value cannot be greater than the allocated size of the buffer, which is returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetMaxLength(System.Int32@)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The specified length is greater than the maximum size of the buffer.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method if you write data into the buffer.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaBuffer::SetCurrentLength']/*"/>
|
|
<msdn-id>ms703202</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaBuffer::SetCurrentLength([In] unsigned int cbCurrentLength)</unmanaged>
|
|
<unmanaged-short>IMFMediaBuffer::SetCurrentLength</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaBuffer.GetMaxLength(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the allocated size of the buffer.</p>
|
|
</summary>
|
|
<param name="cbMaxLengthRef"><dd> <p>Receives the allocated size of the buffer, in bytes.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The buffer might or might not contain any valid data, and if there is valid data in the buffer, it might be smaller than the buffer's allocated size. To get the length of the valid data, call <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetCurrentLength(System.Int32@)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaBuffer::GetMaxLength']/*"/>
|
|
<msdn-id>ms704840</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaBuffer::GetMaxLength([Out] unsigned int* pcbMaxLength)</unmanaged>
|
|
<unmanaged-short>IMFMediaBuffer::GetMaxLength</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaBuffer.CurrentLength">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the length of the valid data in the buffer.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaBuffer::GetCurrentLength']/*"/>
|
|
<msdn-id>ms698987</msdn-id>
|
|
<unmanaged>GetCurrentLength</unmanaged>
|
|
<unmanaged-short>GetCurrentLength</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaBuffer::GetCurrentLength([Out] unsigned int* pcbCurrentLength)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaBuffer.MaxLength">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the allocated size of the buffer.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The buffer might or might not contain any valid data, and if there is valid data in the buffer, it might be smaller than the buffer's allocated size. To get the length of the valid data, call <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetCurrentLength(System.Int32@)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaBuffer::GetMaxLength']/*"/>
|
|
<msdn-id>ms704840</msdn-id>
|
|
<unmanaged>GetMaxLength</unmanaged>
|
|
<unmanaged-short>GetMaxLength</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaBuffer::GetMaxLength([Out] unsigned int* pcbMaxLength)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves an <strong><see cref="T:SharpDX.Result"/></strong> that specifies the event status.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEvent']/*"/>
|
|
<msdn-id>ms704650</msdn-id>
|
|
<unmanaged>IMFMediaEvent</unmanaged>
|
|
<unmanaged-short>IMFMediaEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEvent.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaEvent"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEvent.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaEvent">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaEvent"/>. (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.MediaFoundation.MediaEvent.GetTypeInfo(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the event type. The event type indicates what happened to trigger the event. It also defines the meaning of the event value.</p>
|
|
</summary>
|
|
<param name="metRef"><dd> <p>Receives the event type. For a list of event types, see Media Foundation Events.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEvent::GetType']/*"/>
|
|
<msdn-id>ms702255</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEvent::GetType([Out] unsigned int* pmet)</unmanaged>
|
|
<unmanaged-short>IMFMediaEvent::GetType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEvent.GetExtendedType(System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the extended type of the event.</p>
|
|
</summary>
|
|
<param name="guidExtendedTypeRef"><dd> <p>Receives a <strong><see cref="T:System.Guid"/></strong> that identifies the extended type.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To define a custom event, create a new extended-type <see cref="T:System.Guid"/> and send an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.ExtendedType"/> event with that <see cref="T:System.Guid"/>.</p><p>Some standard Media Foundation events also use the extended type to differentiate between types of event data.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEvent::GetExtendedType']/*"/>
|
|
<msdn-id>ms697235</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEvent::GetExtendedType([Out] GUID* pguidExtendedType)</unmanaged>
|
|
<unmanaged-short>IMFMediaEvent::GetExtendedType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEvent.GetStatus(SharpDX.Result@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves an <strong><see cref="T:SharpDX.Result"/></strong> that specifies the event status.</p>
|
|
</summary>
|
|
<param name="hrStatusRef"><dd> <p>Receives the event status. If the operation that generated the event was successful, the value is a success code. A failure code means that an error condition triggered the event.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEvent::GetStatus']/*"/>
|
|
<msdn-id>ms704650</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEvent::GetStatus([Out] HRESULT* phrStatus)</unmanaged>
|
|
<unmanaged-short>IMFMediaEvent::GetStatus</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEvent.GetValue(SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Represents an event generated by a Media Foundation object. Use this interface to get information about the event.</p><p>To get a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.BeginGetEvent(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.GetEvent(System.Int32,SharpDX.MediaFoundation.MediaEvent@)"/></strong> on the event generator.</p>
|
|
</summary>
|
|
<param name="vValueRef">No documentation.</param>
|
|
<returns>No documentation.</returns>
|
|
<remarks>
|
|
<p>If you are implementing an object that generates events, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaEvent(System.Int32,System.Guid,SharpDX.Result,System.Nullable{SharpDX.Win32.Variant},SharpDX.MediaFoundation.MediaEvent@)"/></strong> function to create a new event object.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEvent::GetValue']/*"/>
|
|
<msdn-id>ms702249</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEvent::GetValue([Out] PROPVARIANT* pvValue)</unmanaged>
|
|
<unmanaged-short>IMFMediaEvent::GetValue</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaEvent.TypeInfo">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the event type. The event type indicates what happened to trigger the event. It also defines the meaning of the event value.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEvent::GetType']/*"/>
|
|
<msdn-id>ms702255</msdn-id>
|
|
<unmanaged>GetType</unmanaged>
|
|
<unmanaged-short>GetType</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaEvent::GetType([Out] unsigned int* pmet)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaEvent.ExtendedType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the extended type of the event.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To define a custom event, create a new extended-type <see cref="T:System.Guid"/> and send an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.ExtendedType"/> event with that <see cref="T:System.Guid"/>.</p><p>Some standard Media Foundation events also use the extended type to differentiate between types of event data.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEvent::GetExtendedType']/*"/>
|
|
<msdn-id>ms697235</msdn-id>
|
|
<unmanaged>GetExtendedType</unmanaged>
|
|
<unmanaged-short>GetExtendedType</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaEvent::GetExtendedType([Out] GUID* pguidExtendedType)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaEvent.Status">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves an <strong><see cref="T:SharpDX.Result"/></strong> that specifies the event status.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEvent::GetStatus']/*"/>
|
|
<msdn-id>ms704650</msdn-id>
|
|
<unmanaged>GetStatus</unmanaged>
|
|
<unmanaged-short>GetStatus</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaEvent::GetStatus([Out] HRESULT* phrStatus)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaEvent.Value">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Represents an event generated by a Media Foundation object. Use this interface to get information about the event.</p><p>To get a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.BeginGetEvent(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.GetEvent(System.Int32,SharpDX.MediaFoundation.MediaEvent@)"/></strong> on the event generator.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If you are implementing an object that generates events, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaEvent(System.Int32,System.Guid,SharpDX.Result,System.Nullable{SharpDX.Win32.Variant},SharpDX.MediaFoundation.MediaEvent@)"/></strong> function to create a new event object.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEvent::GetValue']/*"/>
|
|
<msdn-id>ms702249</msdn-id>
|
|
<unmanaged>GetValue</unmanaged>
|
|
<unmanaged-short>GetValue</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaEvent::GetValue([Out] PROPVARIANT* pvValue)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaEventGenerator">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves events from any Media Foundation object that generates events. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>An object that supports this interface maintains a queue of events. The client of the object can retrieve the events either synchronously or asynchronously. The synchronous method is <strong>GetEvent</strong>. The asynchronous methods are <strong>BeginGetEvent</strong> and <strong>EndGetEvent</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventGenerator']/*"/>
|
|
<msdn-id>ms701755</msdn-id>
|
|
<unmanaged>IMFMediaEventGenerator</unmanaged>
|
|
<unmanaged-short>IMFMediaEventGenerator</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventGenerator.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaEventGenerator"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventGenerator.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaEventGenerator">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaEventGenerator"/>. (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.MediaFoundation.MediaEventGenerator.GetEvent(System.Int32,SharpDX.MediaFoundation.MediaEvent@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the next event in the queue. This method is synchronous.</p>
|
|
</summary>
|
|
<param name="dwFlags"><dd> <p>Specifies one of the following values.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>0</strong></dt> </dl> </td><td> <p>The method blocks until the event generator queues an event.</p> </td></tr> <tr><td><dl> <dt><strong>MF_EVENT_FLAG_NO_WAIT</strong></dt> </dl> </td><td> <p>The method returns immediately.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="eventOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaEvent"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><c>null</c> reference argument.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_MULTIPLE_SUBSCRIBERS</strong></dt> </dl> </td><td> <p>There is a pending request.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_EVENTS_AVAILABLE</strong></dt> </dl> </td><td> <p>There are no events in the queue.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object was shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method executes synchronously.</p><p>If the queue already contains an event, the method returns <see cref="F:SharpDX.Result.Ok"/> immediately. If the queue does not contain an event, the behavior depends on the value of <em>dwFlags</em>:</p><ul> <li> <p>If <em>dwFlags</em> is 0, the method blocks indefinitely until a new event is queued, or until the event generator is shut down.</p> </li> <li> <p>If <em>dwFlags</em> is MF_EVENT_FLAG_NO_WAIT, the method fails immediately with the return code MF_E_NO_EVENTS_AVAILABLE.</p> </li> </ul><p>This method returns MF_E_MULTIPLE_SUBSCRIBERS if you previously called <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.BeginGetEvent(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> and have not yet called <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.EndGetEvent(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.MediaEvent@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventGenerator::GetEvent']/*"/>
|
|
<msdn-id>ms704754</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventGenerator::GetEvent([In] unsigned int dwFlags,[Out] IMFMediaEvent** ppEvent)</unmanaged>
|
|
<unmanaged-short>IMFMediaEventGenerator::GetEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventGenerator.BeginGetEvent(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Begins an asynchronous request for the next event in the queue.</p>
|
|
</summary>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The client must implement this interface.</p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><strong><c>null</c></strong> reference argument.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_MULTIPLE_BEGIN</strong></dt> </dl> </td><td> <p>There is a pending request with the same callback reference and a different state object.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_MULTIPLE_SUBSCRIBERS</strong></dt> </dl> </td><td> <p>There is a pending request with a different callback reference.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object was shut down.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_S_MULTIPLE_BEGIN</strong></dt> </dl> </td><td> <p>There is a pending request with the same callback reference and state object.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When a new event is available, the event generator calls the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. The <strong>Invoke</strong> method should call <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.EndGetEvent(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.MediaEvent@)"/></strong> to get a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaEvent"/></strong> interface, and use that interface to examine the event.</p><p>Do not call <strong>BeginGetEvent</strong> a second time before calling <strong>EndGetEvent</strong>. While the first call is still pending, additional calls to the same object will fail. Also, the <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.GetEvent(System.Int32,SharpDX.MediaFoundation.MediaEvent@)"/></strong> method fails if an asynchronous request is still pending.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventGenerator::BeginGetEvent']/*"/>
|
|
<msdn-id>ms701637</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventGenerator::BeginGetEvent([In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFMediaEventGenerator::BeginGetEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventGenerator.EndGetEvent(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.MediaEvent@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Completes an asynchronous request for the next event in the queue.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong>Invoke</strong> method.</p> </dd></param>
|
|
<param name="eventOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaEvent"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object was shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method from inside your application's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. For example code, see <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.BeginGetEvent(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventGenerator::EndGetEvent']/*"/>
|
|
<msdn-id>ms698866</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventGenerator::EndGetEvent([In] IMFAsyncResult* pResult,[Out] IMFMediaEvent** ppEvent)</unmanaged>
|
|
<unmanaged-short>IMFMediaEventGenerator::EndGetEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventGenerator.QueueEvent(System.Int32,System.Guid,SharpDX.Result,System.Nullable{SharpDX.Win32.Variant})">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Puts a new event in the object's queue.</p>
|
|
</summary>
|
|
<param name="met"><dd> <p>Specifies the event type. The event type is returned by the event's <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetTypeInfo(System.Int32@)"/></strong> method. For a list of event types, see Media Foundation Events.</p> </dd></param>
|
|
<param name="guidExtendedType"><dd> <p>The extended type. If the event does not have an extended type, use the value GUID_NULL. The extended type is returned by the event's <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetExtendedType(System.Guid@)"/></strong> method.</p> </dd></param>
|
|
<param name="hrStatus"><dd> <p>A success or failure code indicating the status of the event. This value is returned by the event's <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetStatus(SharpDX.Result@)"/></strong> method.</p> </dd></param>
|
|
<param name="vValueRef"><dd> <p>Pointer to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that contains the event value. This parameter can be <strong><c>null</c></strong>. This value is returned by the event's <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetValue(SharpDX.Win32.Variant@)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object was shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventGenerator::QueueEvent']/*"/>
|
|
<msdn-id>ms696255</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventGenerator::QueueEvent([In] unsigned int met,[In] const GUID& guidExtendedType,[In] HRESULT hrStatus,[In, Optional] const PROPVARIANT* pvValue)</unmanaged>
|
|
<unmanaged-short>IMFMediaEventGenerator::QueueEvent</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaEventQueue">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Provides an event queue for applications that need to implement the <strong><see cref="T:SharpDX.MediaFoundation.MediaEventGenerator"/></strong> interface.</p><p>This interface is exposed by a helper object that implements an event queue. If you are writing a component that implements the <strong><see cref="T:SharpDX.MediaFoundation.MediaEventGenerator"/></strong> interface, you can use this object in your implementation. The event queue object is thread safe and provides methods to queue events and to pull them from the queue either synchronously or asynchronously. To create the event queue object, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateEventQueue(SharpDX.MediaFoundation.MediaEventQueue@)"/></strong>.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventQueue']/*"/>
|
|
<msdn-id>ms704617</msdn-id>
|
|
<unmanaged>IMFMediaEventQueue</unmanaged>
|
|
<unmanaged-short>IMFMediaEventQueue</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventQueue.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaEventQueue"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventQueue.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaEventQueue">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaEventQueue"/>. (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.MediaFoundation.MediaEventQueue.GetEvent(System.Int32,SharpDX.MediaFoundation.MediaEvent@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the next event in the queue. This method is synchronous.</p><p>Call this method inside your implementation of <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.GetEvent(System.Int32,SharpDX.MediaFoundation.MediaEvent@)"/></strong>. Pass the parameters from that method directly to this method.</p>
|
|
</summary>
|
|
<param name="dwFlags">No documentation.</param>
|
|
<param name="eventOut">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventQueue::GetEvent']/*"/>
|
|
<msdn-id>ms702270</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventQueue::GetEvent([In] unsigned int dwFlags,[Out] IMFMediaEvent** ppEvent)</unmanaged>
|
|
<unmanaged-short>IMFMediaEventQueue::GetEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventQueue.BeginGetEvent(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Begins an asynchronous request for the next event in the queue.</p><p>Call this method inside your implementation of <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.BeginGetEvent(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>. Pass the parameters from that method directly to this method.</p>
|
|
</summary>
|
|
<param name="callbackRef">No documentation.</param>
|
|
<param name="unkStateRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventQueue::BeginGetEvent']/*"/>
|
|
<msdn-id>ms696998</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventQueue::BeginGetEvent([In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFMediaEventQueue::BeginGetEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventQueue.EndGetEvent(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.MediaEvent@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Completes an asynchronous request for the next event in the queue.</p><p>Call this method inside your implementation of <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.EndGetEvent(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.MediaEvent@)"/></strong>. Pass the parameters from that method directly to this method.</p>
|
|
</summary>
|
|
<param name="resultRef">No documentation.</param>
|
|
<param name="eventOut">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventQueue::EndGetEvent']/*"/>
|
|
<msdn-id>ms702986</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventQueue::EndGetEvent([In] IMFAsyncResult* pResult,[Out] IMFMediaEvent** ppEvent)</unmanaged>
|
|
<unmanaged-short>IMFMediaEventQueue::EndGetEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventQueue.QueueEvent(SharpDX.MediaFoundation.MediaEvent)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Puts an event in the queue.</p>
|
|
</summary>
|
|
<param name="eventRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaEvent"/></strong> interface of the event to be put in the queue.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method when your component needs to raise an event that contains attributes. To create the event object, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaEvent(System.Int32,System.Guid,SharpDX.Result,System.Nullable{SharpDX.Win32.Variant},SharpDX.MediaFoundation.MediaEvent@)"/></strong>. Add attributes to the event by using methods from the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. (The <strong><see cref="T:SharpDX.MediaFoundation.MediaEvent"/></strong> interface inherits <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong>.)</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventQueue::QueueEvent']/*"/>
|
|
<msdn-id>ms704792</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventQueue::QueueEvent([In] IMFMediaEvent* pEvent)</unmanaged>
|
|
<unmanaged-short>IMFMediaEventQueue::QueueEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventQueue.QueueEventParamVar(System.Int32,System.Guid,SharpDX.Result,SharpDX.Win32.Variant)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Creates an event, sets a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> as the event data, and puts the event in the queue.</p><p>Call this method inside your implementation of <strong><see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.QueueEvent(System.Int32,System.Guid,SharpDX.Result,System.Nullable{SharpDX.Win32.Variant})"/></strong>. Pass the parameters from that method directly to this method.</p><p>You can also call this method when your component needs to raise an event that does not contain attributes. If the event data is an <strong><see cref="T:SharpDX.ComObject"/></strong> reference, you can use <strong><see cref="M:SharpDX.MediaFoundation.MediaEventQueue.QueueEventParamUnk(System.Int32,System.Guid,SharpDX.Result,SharpDX.ComObject)"/></strong>. If the event contains attributes, use <strong><see cref="M:SharpDX.MediaFoundation.MediaEventQueue.QueueEvent(SharpDX.MediaFoundation.MediaEvent)"/></strong> instead.</p>
|
|
</summary>
|
|
<param name="met">No documentation.</param>
|
|
<param name="guidExtendedType">No documentation.</param>
|
|
<param name="hrStatus">No documentation.</param>
|
|
<param name="vValueRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventQueue::QueueEventParamVar']/*"/>
|
|
<msdn-id>ms704641</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventQueue::QueueEventParamVar([In] unsigned int met,[In] const GUID& guidExtendedType,[In] HRESULT hrStatus,[In] const PROPVARIANT* pvValue)</unmanaged>
|
|
<unmanaged-short>IMFMediaEventQueue::QueueEventParamVar</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventQueue.QueueEventParamUnk(System.Int32,System.Guid,SharpDX.Result,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Creates an event, sets an <strong><see cref="T:SharpDX.ComObject"/></strong> reference as the event data, and puts the event in the queue.</p>
|
|
</summary>
|
|
<param name="met"><dd> <p>Specifies the event type of the event to be added to the queue. The event type is returned by the event's <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetTypeInfo(System.Int32@)"/></strong> method. For a list of event types, see Media Foundation Events.</p> </dd></param>
|
|
<param name="guidExtendedType"><dd> <p>The extended type of the event. If the event does not have an extended type, use the value GUID_NULL. The extended type is returned by the event's <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetExtendedType(System.Guid@)"/></strong> method.</p> </dd></param>
|
|
<param name="hrStatus"><dd> <p>A success or failure code indicating the status of the event. This value is returned by the event's <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetStatus(SharpDX.Result@)"/></strong> method.</p> </dd></param>
|
|
<param name="unkRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The method sets this reference as the event value. The reference is returned by the event's <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetValue(SharpDX.Win32.Variant@)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method when your component needs to raise an event that contains an <strong><see cref="T:SharpDX.ComObject"/></strong> reference value and no attributes. If the event contains attributes, use <strong><see cref="M:SharpDX.MediaFoundation.MediaEventQueue.QueueEvent(SharpDX.MediaFoundation.MediaEvent)"/></strong> instead.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventQueue::QueueEventParamUnk']/*"/>
|
|
<msdn-id>ms704686</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventQueue::QueueEventParamUnk([In] unsigned int met,[In] const GUID& guidExtendedType,[In] HRESULT hrStatus,[In] IUnknown* pUnk)</unmanaged>
|
|
<unmanaged-short>IMFMediaEventQueue::QueueEventParamUnk</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaEventQueue.Shutdown">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Shuts down the event queue.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method when your component shuts down. After this method is called, all <strong><see cref="T:SharpDX.MediaFoundation.MediaEventQueue"/></strong> methods return <strong>MF_E_SHUTDOWN</strong>.</p><p>This method removes all of the events from the queue.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaEventQueue::Shutdown']/*"/>
|
|
<msdn-id>ms698923</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaEventQueue::Shutdown()</unmanaged>
|
|
<unmanaged-short>IMFMediaEventQueue::Shutdown</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaSession">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Provides playback controls for protected and unprotected content. The Media Session and the protected media path (PMP) session objects expose this interface. This interface is the primary interface that applications use to control the Media Foundation pipeline.</p><p>To obtain a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaSession(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong>.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession']/*"/>
|
|
<msdn-id>ms705662</msdn-id>
|
|
<unmanaged>IMFMediaSession</unmanaged>
|
|
<unmanaged-short>IMFMediaSession</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaSession"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaSession">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaSession"/>. (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.MediaFoundation.MediaSession.SetTopology(System.Int32,SharpDX.MediaFoundation.Topology)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Sets a topology on the Media Session. </p>
|
|
</summary>
|
|
<param name="dwSetTopologyFlags"><dd> <p> Bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.SessionSettopologyFlags"/></strong> enumeration. </p> </dd></param>
|
|
<param name="topologyRef"><dd> <p> Pointer to the topology object's <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p> The operation cannot be performed in the Media Session's current state. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p> The Media Session has been shut down. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TOPO_INVALID_TIME_ATTRIBUTES</strong></dt> </dl> </td><td> <p>The topology has invalid values for one or more of the following attributes:</p> <ul> <li> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Mediastart"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Mediastop"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.TopologyAttributeKeys.ProjectStart"/></strong> </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.TopologyAttributeKeys.ProjectStop"/></strong> </li> </ul> </td></tr> <tr><td> <dl> <dt><strong>NS_E_DRM_DEBUGGING_NOT_ALLOWED</strong></dt> </dl> </td><td> <p> Protected content cannot be played while debugging. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If <em>pTopology</em> is a full topology, set the <strong><see cref="F:SharpDX.MediaFoundation.SessionSettopologyFlags.Noresolution"/></strong> flag in the <em>dwSetTopologyFlags</em> parameter. Otherwise, the topology is assumed to be a partial topology. The Media Session uses the topology loader to resolve a partial topology into a full topology.</p><p>If the Media Session is currently paused or stopped, the <strong>SetTopology</strong> method does not take effect until the next call to <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.Start(System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong>.</p><p>If the Media Session is currently running, or on the next call to <strong>Start</strong>, the <strong>SetTopology</strong> method does the following:</p><ul> <li>If the <strong><see cref="F:SharpDX.MediaFoundation.SessionSettopologyFlags.Immediate"/></strong> flag is set in <em>dwSetTopologyFlags</em>, the Media Session ends the current presentation immediately, clears all pending topologies, and uses <em>pTopology</em> to start a new presentation.</li> <li>Otherwise, the Media Session queues <em>pTopology</em> and starts the new presentation when the current presentation has completed. If there is no current presentation, the new presentation starts immediately.</li> <li>Starting in Windows?7, you can also specify the <strong><see cref="F:SharpDX.MediaFoundation.SessionSettopologyFlags.ClearCurrent"/></strong> flag to clear the current topology but leave any other pending topologies on the queue.</li> </ul><p> This method is asynchronous. If the method returns <see cref="F:SharpDX.Result.Ok"/>, the Media Session sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologySet"/> event when the operation completes. If the Media Session is currently paused to stopped, the Media Session does not send the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologySet"/> event until the next call to <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.Start(System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong> </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::SetTopology']/*"/>
|
|
<msdn-id>ms704785</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSession::SetTopology([In] unsigned int dwSetTopologyFlags,[In, Optional] IMFTopology* pTopology)</unmanaged>
|
|
<unmanaged-short>IMFMediaSession::SetTopology</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.ClearTopologies">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Clears all of the presentations that are queued for playback in the Media Session.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p> The operation cannot be performed in the Media Session's current state. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p> The Media Session has been shut down. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is asynchronous. When the operation completes, the Media Session sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologiesCleared"/> event.</p><p>This method does not clear the current topology; it only removes topologies that are placed in the queue, waiting for playback. To remove the current topology, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.SetTopology(System.Int32,SharpDX.MediaFoundation.Topology)"/></strong> with the <strong><see cref="F:SharpDX.MediaFoundation.SessionSettopologyFlags.ClearCurrent"/></strong> flag.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::ClearTopologies']/*"/>
|
|
<msdn-id>ms705648</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSession::ClearTopologies()</unmanaged>
|
|
<unmanaged-short>IMFMediaSession::ClearTopologies</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.Start(System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Starts the Media Session. </p>
|
|
</summary>
|
|
<param name="guidTimeFormatRef"><dd> <p>Pointer to a <see cref="T:System.Guid"/> that specifies the time format for the <em>pvarStartPosition</em> parameter. This parameter can be <strong><c>null</c></strong>. The value <strong><c>null</c></strong> is equivalent to passing in <strong>GUID_NULL</strong>.</p> <p>The following time format GUIDs are defined:</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>GUID_NULL</strong></dt> </dl> </td><td> <p>Presentation time. The <em>pvarStartPosition</em> parameter must have one of the following <strong><see cref="T:SharpDX.Win32.Variant"/></strong> types.</p> <ul> <li><strong>VT_I8</strong>: The <em>pvarStartPosition</em> parameter contains the starting position in 100-nanosecond units, relative to the start of the presentation.</li> <li><strong>VT_EMPTY</strong>: Playback starts from the current position.</li> </ul> <p>All media sources support this time format.</p> </td></tr> <tr><td><dl> <dt><strong>MF_TIME_FORMAT_SEGMENT_OFFSET</strong></dt> </dl> </td><td> <p>Segment offset. This time format is supported by the Sequencer Source. The starting time is an offset within a segment.</p> <p>Call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSequencerSegmentOffset(System.Int32,System.Int64,SharpDX.Win32.Variant@)"/></strong> function to create the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> value for the <em>pvarStartPosition</em> parameter.</p> </td></tr> <tr><td><dl> <dt><strong>MF_TIME_FORMAT_ENTRY_RELATIVE</strong></dt> </dl> </td><td> <p><strong>Note</strong>??Requires Windows?7 or later.</p> <p>Skip to a playlist entry. The <em>pvarStartPosition</em> parameter specifies the index of the playlist entry, relative to the current entry. For example, the value 2 skips forward two entries. To skip backward, pass a negative value. The <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type is <strong>VT_I4</strong>.</p> <p>If a media source supports this time format, the <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.GetCharacteristics(System.Int32@)"/></strong> method returns one or both of the following flags:</p> <ul> <li><strong><see cref="F:SharpDX.MediaFoundation.MediasourceCharacteristics.CanSkipforward"/></strong></li> <li><strong><see cref="F:SharpDX.MediaFoundation.MediasourceCharacteristics.CanSkipbackward"/></strong></li> </ul> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="varStartPositionRef"><dd> <p> Pointer to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that specifies the starting position for playback. The meaning and data type of this parameter are indicated by the <em>pguidTimeFormat</em> parameter. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p> The operation cannot be performed in the Media Session's current state. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p> The Media Session has been shut down. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When this method is called, the Media Session starts the presentation clock and begins to process media samples.</p><p>This method is asynchronous. When the method completes, the Media Session sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionStarted"/> event.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::Start']/*"/>
|
|
<msdn-id>ms694908</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSession::Start([In, Optional] const GUID* pguidTimeFormat,[In, Optional] const PROPVARIANT* pvarStartPosition)</unmanaged>
|
|
<unmanaged-short>IMFMediaSession::Start</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.Pause">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Provides playback controls for protected and unprotected content. The Media Session and the protected media path (PMP) session objects expose this interface. This interface is the primary interface that applications use to control the Media Foundation pipeline.</p><p>To obtain a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaSession(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong>.</p>
|
|
</summary>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::Pause']/*"/>
|
|
<msdn-id>ms705662</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSession::Pause()</unmanaged>
|
|
<unmanaged-short>IMFMediaSession::Pause</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.Stop">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Provides playback controls for protected and unprotected content. The Media Session and the protected media path (PMP) session objects expose this interface. This interface is the primary interface that applications use to control the Media Foundation pipeline.</p><p>To obtain a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMediaSession(SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePMPMediaSession(System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaSession@,SharpDX.MediaFoundation.Activate@)"/></strong>.</p>
|
|
</summary>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::Stop']/*"/>
|
|
<msdn-id>ms705662</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSession::Stop()</unmanaged>
|
|
<unmanaged-short>IMFMediaSession::Stop</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.Close">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Closes the Media Session and releases all of the resources it is using.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The Media Session has been shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is asynchronous. When the operation completes, the Media Session sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionClosed"/> event.</p><p>After the <strong>Close</strong> method is called, the only valid methods on the Media Session are the following:</p><ul> <li> <p> <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.GetClock(SharpDX.MediaFoundation.Clock@)"/></strong> </p> </li> <li> <p> <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.GetFullTopology(System.Int32,System.Int64,SharpDX.MediaFoundation.Topology@)"/></strong> </p> </li> <li> <p> <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.GetSessionCapabilities(System.Int32@)"/></strong> </p> </li> <li> <p> <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.Shutdown"/></strong> </p> </li> </ul><p>All other methods return MF_E_INVALIDREQUEST, or else queue an event with that error code.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::Close']/*"/>
|
|
<msdn-id>ms698928</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSession::Close()</unmanaged>
|
|
<unmanaged-short>IMFMediaSession::Close</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.Shutdown">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Shuts down the Media Session and releases all the resources used by the Media Session.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method when you are done using the Media Session, before the final call to <strong>IUnknown::Release</strong>. Otherwise, your application will leak memory.</p><p>After this method is called, other <strong><see cref="T:SharpDX.MediaFoundation.MediaSession"/></strong> methods return MF_E_SHUTDOWN.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::Shutdown']/*"/>
|
|
<msdn-id>ms697318</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSession::Shutdown()</unmanaged>
|
|
<unmanaged-short>IMFMediaSession::Shutdown</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.GetClock(SharpDX.MediaFoundation.Clock@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the Media Session's presentation clock.</p>
|
|
</summary>
|
|
<param name="clockOut"><dd> <p>Receives a reference to the presentation clock's <strong><see cref="T:SharpDX.MediaFoundation.Clock"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_UNEXPECTED</strong></dt> </dl> </td><td> <p>The Media Session does not have a presentation clock.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The Media Session has been shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The application can query the returned <strong><see cref="T:SharpDX.MediaFoundation.Clock"/></strong> reference for the <strong><see cref="T:SharpDX.MediaFoundation.PresentationClock"/></strong> interface. However, the application should not use this interface to control the state of the presentation clock. Instead, the application should always call the transport control methods on the Media Session's <strong><see cref="T:SharpDX.MediaFoundation.MediaSession"/></strong> interface, such as <strong>Start</strong>, <strong>Stop</strong>, and <strong>Pause</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::GetClock']/*"/>
|
|
<msdn-id>bb970342</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSession::GetClock([Out] IMFClock** ppClock)</unmanaged>
|
|
<unmanaged-short>IMFMediaSession::GetClock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.GetSessionCapabilities(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the capabilities of the Media Session, based on the current presentation.</p>
|
|
</summary>
|
|
<param name="dwCapsRef"><dd> <p>Receives a bitwise <strong>OR</strong> of zero or more of the following flags.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>MFSESSIONCAP_PAUSE</strong></dt> </dl> </td><td> <p>The Media Session can be paused.</p> </td></tr> <tr><td><dl> <dt><strong>MFSESSIONCAP_RATE_FORWARD</strong></dt> </dl> </td><td> <p>The Media Session supports forward playback at rates faster than 1.0.</p> </td></tr> <tr><td><dl> <dt><strong>MFSESSIONCAP_RATE_REVERSE</strong></dt> </dl> </td><td> <p>The Media Session supports reverse playback.</p> </td></tr> <tr><td><dl> <dt><strong>MFSESSIONCAP_SEEK</strong></dt> </dl> </td><td> <p>The Media Session can be seeked.</p> </td></tr> <tr><td><dl> <dt><strong>MFSESSIONCAP_START</strong></dt> </dl> </td><td> <p>The Media Session can be started.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_POINTER</strong></dt> </dl> </td><td> <p><c>null</c> reference argument.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The Media Session has been shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::GetSessionCapabilities']/*"/>
|
|
<msdn-id>ms696229</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSession::GetSessionCapabilities([Out] unsigned int* pdwCaps)</unmanaged>
|
|
<unmanaged-short>IMFMediaSession::GetSessionCapabilities</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSession.GetFullTopology(System.Int32,System.Int64,SharpDX.MediaFoundation.Topology@)">
|
|
<summary>
|
|
<p>Retrieves a pending or current topology from the media session.</p> <see cref="T:SharpDX.Result"/> GetFullTopology( DWORD dwGetFullTopologyFlags, TOPOID TopoId, <see cref="T:SharpDX.MediaFoundation.Topology"/>** ppFullTopo
|
|
);
|
|
<p></p>Parameters <p> dwGetFullTopologyFlags </p> <p>[in] Bitwise OR of zero or more flags from the <see cref="T:SharpDX.MediaFoundation.SessionGetfulltopologyFlags"/> Enumeration. </p> <p> TopoId </p> <p>[in] Identifier of the topology to retrieve. This parameter is ignored if the <see cref="F:SharpDX.MediaFoundation.SessionGetfulltopologyFlags.Current"/> flag is set in the Flags parameter. To get the topology identifier from a topology object, call <see cref="M:SharpDX.MediaFoundation.Topology.GetTopologyID(System.Int64@)"/>.</p> <p> ppFullTopo </p> <p>[out] Receives a reference to the <see cref="T:SharpDX.MediaFoundation.Topology"/> Interface of the topology. The caller must release the interface.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>MF_E_SHUTDOWN</p> </td> <td> <p>The media session has been shut down.</p> </td> </tr></table> <p>If the <see cref="F:SharpDX.MediaFoundation.SessionGetfulltopologyFlags.Current"/> flag is specified in the Flags parameter, the method returns the topology for the current presentation. Otherwise, the method searches all of the queued topologies for one that matches the identifier given in the TopoId parameter.</p> <p>This method can be used to retrieve the topology for the current presentation or any pending presentations. It cannot be used to retrieve a topology that has already ended.</p> <p>The topology returned in ppFullTopo is a full topology, not a partial topology.</p> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFMediaSession Interface
|
|
</summary>
|
|
<param name="dwGetFullTopologyFlags">No documentation.</param>
|
|
<param name="topoId">No documentation.</param>
|
|
<param name="fullTopologyOut">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='IMFMediaSession::GetFullTopology']/*"/>
|
|
<msdn-id>ms697481</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSession::GetFullTopology([In] unsigned int dwGetFullTopologyFlags,[In] unsigned longlong TopoId,[Out] IMFTopology** ppFullTopology)</unmanaged>
|
|
<unmanaged-short>IMFMediaSession::GetFullTopology</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaSession.Clock">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the Media Session's presentation clock.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The application can query the returned <strong><see cref="T:SharpDX.MediaFoundation.Clock"/></strong> reference for the <strong><see cref="T:SharpDX.MediaFoundation.PresentationClock"/></strong> interface. However, the application should not use this interface to control the state of the presentation clock. Instead, the application should always call the transport control methods on the Media Session's <strong><see cref="T:SharpDX.MediaFoundation.MediaSession"/></strong> interface, such as <strong>Start</strong>, <strong>Stop</strong>, and <strong>Pause</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::GetClock']/*"/>
|
|
<msdn-id>bb970342</msdn-id>
|
|
<unmanaged>GetClock</unmanaged>
|
|
<unmanaged-short>GetClock</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaSession::GetClock([Out] IMFClock** ppClock)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaSession.SessionCapabilities">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the capabilities of the Media Session, based on the current presentation.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSession::GetSessionCapabilities']/*"/>
|
|
<msdn-id>ms696229</msdn-id>
|
|
<unmanaged>GetSessionCapabilities</unmanaged>
|
|
<unmanaged-short>GetSessionCapabilities</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaSession::GetSessionCapabilities([Out] unsigned int* pdwCaps)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaSinkPreroll">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Enables a media sink to receive samples before the presentation clock is started.</p><p>To get a reference to this interface, call <strong>QueryInterface</strong> on the media sink.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Media sinks can implement this interface to support seamless playback and transitions. If a media sink exposes this interface, it can receive samples before the presentation clock starts. It can then pre-process the samples, so that rendering can begin immediately when the clock starts. Prerolling helps to avoid glitches during playback.</p><p>If a media sink supports preroll, the media sink's <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.GetCharacteristics(System.Int32@)"/></strong> method should return the MEDIASINK_CAN_PREROLL flag.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSinkPreroll']/*"/>
|
|
<msdn-id>ms699832</msdn-id>
|
|
<unmanaged>IMFMediaSinkPreroll</unmanaged>
|
|
<unmanaged-short>IMFMediaSinkPreroll</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSinkPreroll.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaSinkPreroll"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSinkPreroll.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaSinkPreroll">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaSinkPreroll"/>. (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.MediaFoundation.MediaSinkPreroll.NotifyPreroll(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Notifies the media sink that the presentation clock is about to start. </p>
|
|
</summary>
|
|
<param name="hnsUpcomingStartTime"><dd> <p> The upcoming start time for the presentation clock, in 100-nanosecond units. This time is the same value that will be given to the <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.Start(System.Int64)"/></strong> method when the presentation clock is started. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> After this method is called, the media sink sends any number of <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkRequestSample"/> events to request samples, until is has enough preroll data. When it has enough preroll data, the media sink sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkPrerolled"/> event. This event signals that the client can start the presentation clock. </p><p> During preroll, the media sink can prepare the samples that it receives, so that they are ready to be rendered. It does not actually render any samples until the clock starts. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSinkPreroll::NotifyPreroll']/*"/>
|
|
<msdn-id>ms703799</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSinkPreroll::NotifyPreroll([In] longlong hnsUpcomingStartTime)</unmanaged>
|
|
<unmanaged-short>IMFMediaSinkPreroll::NotifyPreroll</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaSource">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Implemented by media source objects.</p><p>Media sources are objects that generate media data. For example, the data might come from a video file, a network stream, or a hardware device, such as a camera. Each media source contains one or more streams, and each stream delivers data of one type, such as audio or video.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSource']/*"/>
|
|
<msdn-id>ms700189</msdn-id>
|
|
<unmanaged>IMFMediaSource</unmanaged>
|
|
<unmanaged-short>IMFMediaSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSource.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaSource"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSource.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaSource">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaSource"/>. (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.MediaFoundation.MediaSource.GetCharacteristics(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the characteristics of the media source.</p>
|
|
</summary>
|
|
<param name="dwCharacteristicsRef"><dd> <p>Receives a bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.MediasourceCharacteristics"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media source's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The characteristics of a media source can change at any time. If this happens, the source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceCharacteristicsChanged"/> event.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSource::GetCharacteristics']/*"/>
|
|
<msdn-id>ms703148</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSource::GetCharacteristics([Out] unsigned int* pdwCharacteristics)</unmanaged>
|
|
<unmanaged-short>IMFMediaSource::GetCharacteristics</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSource.CreatePresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a copy of the media source's presentation descriptor. Applications use the presentation descriptor to select streams and to get information about the source content.</p>
|
|
</summary>
|
|
<param name="presentationDescriptorOut"><dd> <p>Receives a reference to the presentation descriptor's <strong><see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media source's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The presentation descriptor contains the media source's default settings for the presentation. The application can change these settings by selecting or deselecting streams, or by changing the media type on a stream. Do not modify the presentation descriptor unless the source is stopped. The changes take affect when the source's <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Start(SharpDX.MediaFoundation.PresentationDescriptor,System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong> method is called.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSource::CreatePresentationDescriptor']/*"/>
|
|
<msdn-id>ms702261</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSource::CreatePresentationDescriptor([Out] IMFPresentationDescriptor** ppPresentationDescriptor)</unmanaged>
|
|
<unmanaged-short>IMFMediaSource::CreatePresentationDescriptor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSource.Start(SharpDX.MediaFoundation.PresentationDescriptor,System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Starts, seeks, or restarts the media source by specifying where to start playback.</p>
|
|
</summary>
|
|
<param name="presentationDescriptorRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/></strong> interface of the media source's presentation descriptor. To get the presentation descriptor, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.CreatePresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor@)"/></strong>. You can modify the presentation descriptor before calling <strong>Start</strong>, to select or deselect streams or change the media types. </p> </dd></param>
|
|
<param name="guidTimeFormatRef"><dd> <p> Pointer to a <see cref="T:System.Guid"/> that specifies the time format. The time format defines the units for the <em>pvarStartPosition</em> parameter. If the value <em></em> is <strong>GUID_NULL</strong>, the time format is 100-nanosecond units. Some media sources might support additional time format GUIDs. This parameter can be <strong><c>null</c></strong>. If the value is <strong><c>null</c></strong>, it is equalivent to <strong>GUID_NULL</strong>. </p> </dd></param>
|
|
<param name="varStartPositionRef"><dd> <p> Specifies where to start playback. The units of this parameter are indicated by the time format given in <em>pguidTimeFormat</em>. If the time format is <strong>GUID_NULL</strong>, the variant type must be <strong>VT_I8</strong> or <strong>VT_EMPTY</strong>. Use <strong>VT_I8</strong> to specify a new starting position, in 100-nanosecond units. Use <strong>VT_EMPTY</strong> to start from the current position. Other time formats might use other <strong><see cref="T:SharpDX.Win32.Variant"/></strong> types. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ASF_OUTOFRANGE</strong></dt> </dl> </td><td> <p> The start position is past the end of the presentation (ASF media source). </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_HW_MFT_FAILED_START_STREAMING</strong></dt> </dl> </td><td> <p>A hardware device was unable to start streaming. This error code can be returned by a media source that represents a hardware device, such as a camera. For example, if the camera is already being used by another application, the method might return this error code.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p> The start request is not valid. For example, the start position is past the end of the presentation. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p> The media source's <strong>Shutdown</strong> method has been called. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_TIME_FORMAT</strong></dt> </dl> </td><td> <p> The media source does not support the time format specified in <em>pguidTimeFormat</em>. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is asynchronous. If the operation succeeds, the media source sends the following events:</p><ul> <li> For each new stream, the source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.NewStream"/> event. This event is sent for the first <strong>Start</strong> call in which the stream appears. The event data is a reference to the stream's <strong><see cref="T:SharpDX.MediaFoundation.MediaStream"/></strong> interface. </li> <li> For each <em>updated</em> stream, the source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.UpdatedStream"/> event. A stream is updated if the stream already existed when <strong>Start</strong> was called (for example, if the application seeks during playback). The event data is a reference to the stream's <strong><see cref="T:SharpDX.MediaFoundation.MediaStream"/></strong> interface. </li> <li> If the previous state was stopped, the source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceStarted"/> event. </li> <li> If the previous state was started or paused and the starting position is the current position (<strong>VT_EMPTY</strong>), the source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceStarted"/> event. </li> <li> If the previous state was started or paused, and a new starting position is specified, the source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceSeeked"/> event. </li> <li> If the source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceStarted"/> event, each media stream sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamStarted"/> event. If the source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceSeeked"/> event, each stream sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSeeked"/> event. </li> </ul><p> If the start operation fails asynchronously (after the method returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>), the media source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceStarted"/> event that contains a failure code, without sending any of the other events listed here. If the method fails synchronously (returns an error code), no events are raised. </p><p> A call to <strong>Start</strong> results in a <em>seek</em> if the previous state was started or paused, and the new starting position is not <strong>VT_EMPTY</strong>. Not every media source can seek. If a media source can seek, the <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.GetCharacteristics(System.Int32@)"/></strong> method returns the <strong><see cref="F:SharpDX.MediaFoundation.MediasourceCharacteristics.CanSeek"/></strong> flag. </p><p> Events from the media source are not synchronized with events from the media streams. If you seek a media source, therefore, you can still receive samples from the earlier position after getting the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceSeeked"/> event. If you need to synchronize the operations, wait for the stream event, <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSeeked"/>, which marks the exact point in the stream where the seek occurs. </p>End of Stream<p>When a stream plays to the end, the stream sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.EndOfStream"/> event. When all of the selected streams have reached the end, the media source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.EndOfPresentation"/> event.</p><p>If the starting position is past the end of a selected stream (but before the end of the presentation), the stream should send <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.EndOfStream"/> immediately after <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamStarted"/>/<see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSeeked"/>. If playback reaches the end of the presentation and <strong>Start</strong> is called again from the current position, the streams re-send the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.EndOfStream"/> event and the media source re-sends the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.EndOfPresentation"/> event. These events inform the pipeline not to request any more data.</p><p>During reverse playback, the start of the file is considered the end of the stream. For more information, see Implementing Rate Control.</p>Implementing Start<p>When a media source executes a seek, it should start at the first key frame before the seek time, so that the decoder can decode the samples for the target start time. The pipeline will discard any decoded samples that are too early.</p><p>If the start time is <strong>VT_EMPTY</strong> and the previous state was started or paused, the source should resume from its current position. In this case, it is not necessary to resend the previous key frame, because the decoder will still have the data that was previously sent.</p><p>When validating the <em>pPresentationDescriptor</em> parameter, the media source should check only for the information that it needs to function correctly. In particular, the client can add private attributes to the presentation descriptor. The presence of additional attributes should not cause the <strong>Start</strong> method to fail.</p><p>After <strong>Start</strong> is called, each stream on the media source must do one of the following:</p><ul> <li>Deliver media data in response to <strong><see cref="M:SharpDX.MediaFoundation.MediaStream.RequestSample(SharpDX.ComObject)"/></strong> calls.</li> <li>Send <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamTick"/> events to indicate a gap in the stream.</li> <li>Send an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.EndOfStream"/> event to indicate the end of the stream.</li> </ul><p>For more information, see Writing a Custom Media Source.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSource::Start']/*"/>
|
|
<msdn-id>ms694101</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSource::Start([In, Optional] IMFPresentationDescriptor* pPresentationDescriptor,[In, Optional] const GUID* pguidTimeFormat,[In, Optional] const PROPVARIANT* pvarStartPosition)</unmanaged>
|
|
<unmanaged-short>IMFMediaSource::Start</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSource.Stop">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Stops all active streams in the media source.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media source's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is asynchronous. When the operation completes, the media source sends and <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceStopped"/> event, and every active stream sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamStopped"/> event. If the method returns a failure code, no events are raised.</p><p>When a media source is stopped, its current position reverts to zero. After that, if the <strong>Start</strong> method is called with VT_EMPTY for the starting position, playback starts from the beginning of the presentation.</p><p>While the source is stopped, no streams produce data.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSource::Stop']/*"/>
|
|
<msdn-id>ms702045</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSource::Stop()</unmanaged>
|
|
<unmanaged-short>IMFMediaSource::Stop</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSource.Pause">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Pauses all active streams in the media source.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALID_STATE_TRANSITION</strong></dt> </dl> </td><td> <p>Invalid state transition. The media source must be in the started state.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media source's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is asynchronous. When the operation completes, the media source sends and <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourcePaused"/> event, and every active stream sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamPaused"/> event. If the method returns a failure code, no events are raised.</p><p>The media source must be in the started state. The method fails if the media source is paused or stopped.</p><p>While the source is paused, calls to <strong><see cref="M:SharpDX.MediaFoundation.MediaStream.RequestSample(SharpDX.ComObject)"/></strong> succeed, but the streams will not deliver any samples until after the source is started again. Note that the source's event queue is not serialized with the stream event queues, so the client might receive some samples after the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourcePaused"/> event, due to multi-threading issues. But the client will not receive any samples from a stream after the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamPaused"/> event.</p><p>Not every media source can pause. If a media source can pause, the <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.GetCharacteristics(System.Int32@)"/></strong> method returns the <see cref="F:SharpDX.MediaFoundation.MediasourceCharacteristics.CanPause"/> flag.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSource::Pause']/*"/>
|
|
<msdn-id>ms694275</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSource::Pause()</unmanaged>
|
|
<unmanaged-short>IMFMediaSource::Pause</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSource.Shutdown">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Shuts down the media source and releases the resources it is using.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the application creates the media source, either directly or through the source resolver, the application is responsible for calling <strong>Shutdown</strong> to avoid memory or resource leaks.</p><p>After this method is called, methods on the media source and all of its media streams return MF_E_SHUTDOWN (except for <strong><see cref="T:SharpDX.ComObject"/></strong> methods).</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSource::Shutdown']/*"/>
|
|
<msdn-id>ms703110</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSource::Shutdown()</unmanaged>
|
|
<unmanaged-short>IMFMediaSource::Shutdown</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaSource.Characteristics">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the characteristics of the media source.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The characteristics of a media source can change at any time. If this happens, the source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceCharacteristicsChanged"/> event.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSource::GetCharacteristics']/*"/>
|
|
<msdn-id>ms703148</msdn-id>
|
|
<unmanaged>GetCharacteristics</unmanaged>
|
|
<unmanaged-short>GetCharacteristics</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaSource::GetCharacteristics([Out] unsigned int* pdwCharacteristics)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaSourceEx">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Extends the <strong><see cref="T:SharpDX.MediaFoundation.MediaSource"/></strong> interface to provide additional capabilities for a media source.</p><p>To get a reference to this interface, call <strong>QueryInterface</strong> on the media source. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Implementations of this interface can return <strong>E_NOTIMPL</strong> for any methods that are not required by the media source.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSourceEx']/*"/>
|
|
<msdn-id>hh448029</msdn-id>
|
|
<unmanaged>IMFMediaSourceEx</unmanaged>
|
|
<unmanaged-short>IMFMediaSourceEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSourceEx.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaSourceEx"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSourceEx.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaSourceEx">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaSourceEx"/>. (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.MediaFoundation.MediaSourceEx.GetSourceAttributes(SharpDX.MediaFoundation.MediaAttributes@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets an attribute store for the media source.</p>
|
|
</summary>
|
|
<param name="attributesOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>The media source does not support source-level attributes.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Use the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> reference to get or set attributes that apply to the entire source. For stream-level attributes, use the <strong><see cref="M:SharpDX.MediaFoundation.MediaSourceEx.GetStreamAttributes(System.Int32,SharpDX.MediaFoundation.MediaAttributes@)"/></strong> method instead.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSourceEx::GetSourceAttributes']/*"/>
|
|
<msdn-id>hh448030</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSourceEx::GetSourceAttributes([Out] IMFAttributes** ppAttributes)</unmanaged>
|
|
<unmanaged-short>IMFMediaSourceEx::GetSourceAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSourceEx.GetStreamAttributes(System.Int32,SharpDX.MediaFoundation.MediaAttributes@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets an attribute store for a stream on the media source.</p>
|
|
</summary>
|
|
<param name="dwStreamIdentifier"><dd> <p>The identifier of the stream. To get the identifier, call <strong><see cref="M:SharpDX.MediaFoundation.StreamDescriptor.GetStreamIdentifier(System.Int32@)"/></strong> on the stream descriptor.</p> </dd></param>
|
|
<param name="attributesOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>The media source does not support stream-level attributes.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p>Invalid stream identifier.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Use the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> reference to get or set attributes that apply to the specified stream. For attributes that apply to the entire source, use the <strong><see cref="M:SharpDX.MediaFoundation.MediaSourceEx.GetSourceAttributes(SharpDX.MediaFoundation.MediaAttributes@)"/></strong> method instead.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSourceEx::GetStreamAttributes']/*"/>
|
|
<msdn-id>hh448031</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSourceEx::GetStreamAttributes([In] unsigned int dwStreamIdentifier,[Out] IMFAttributes** ppAttributes)</unmanaged>
|
|
<unmanaged-short>IMFMediaSourceEx::GetStreamAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSourceEx.SetD3DManager(SharpDX.ComObject)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Sets a reference to the Microsoft DirectX Graphics Infrastructure (DXGI) Device Manager on the media source.</p>
|
|
</summary>
|
|
<param name="managerRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the DXGI Manager. The media source should query this reference for the <strong><see cref="T:SharpDX.MediaFoundation.DXGIDeviceManager"/></strong> interface.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>The media source does not support source-level attributes.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSourceEx::SetD3DManager']/*"/>
|
|
<msdn-id>hh448032</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSourceEx::SetD3DManager([In, Optional] IUnknown* pManager)</unmanaged>
|
|
<unmanaged-short>IMFMediaSourceEx::SetD3DManager</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaSourceEx.SourceAttributes">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets an attribute store for the media source.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Use the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> reference to get or set attributes that apply to the entire source. For stream-level attributes, use the <strong><see cref="M:SharpDX.MediaFoundation.MediaSourceEx.GetStreamAttributes(System.Int32,SharpDX.MediaFoundation.MediaAttributes@)"/></strong> method instead.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSourceEx::GetSourceAttributes']/*"/>
|
|
<msdn-id>hh448030</msdn-id>
|
|
<unmanaged>GetSourceAttributes</unmanaged>
|
|
<unmanaged-short>GetSourceAttributes</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaSourceEx::GetSourceAttributes([Out] IMFAttributes** ppAttributes)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaSourceEx.D3DManager">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Sets a reference to the Microsoft DirectX Graphics Infrastructure (DXGI) Device Manager on the media source.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSourceEx::SetD3DManager']/*"/>
|
|
<msdn-id>hh448032</msdn-id>
|
|
<unmanaged>SetD3DManager</unmanaged>
|
|
<unmanaged-short>SetD3DManager</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaSourceEx::SetD3DManager([In, Optional] IUnknown* pManager)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaSourcePresentationProvider">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Notifies the source when playback has reached the end of a segment. For timelines, this corresponds to reaching a mark-out point.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSourcePresentationProvider']/*"/>
|
|
<msdn-id>ms705639</msdn-id>
|
|
<unmanaged>IMFMediaSourcePresentationProvider</unmanaged>
|
|
<unmanaged-short>IMFMediaSourcePresentationProvider</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSourcePresentationProvider.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaSourcePresentationProvider"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSourcePresentationProvider.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaSourcePresentationProvider">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaSourcePresentationProvider"/>. (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.MediaFoundation.MediaSourcePresentationProvider.ForceEndOfPresentation(SharpDX.MediaFoundation.PresentationDescriptor)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Notifies the source when playback has reached the end of a segment. For timelines, this corresponds to reaching a mark-out point.</p>
|
|
</summary>
|
|
<param name="presentationDescriptorRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/></strong> interface of the presentation descriptor for the segment that has ended.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSourcePresentationProvider::ForceEndOfPresentation']/*"/>
|
|
<msdn-id>ms705639</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSourcePresentationProvider::ForceEndOfPresentation([In, Optional] IMFPresentationDescriptor* pPresentationDescriptor)</unmanaged>
|
|
<unmanaged-short>IMFMediaSourcePresentationProvider::ForceEndOfPresentation</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaSourceTopologyProvider">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Enables an application to get a topology from the sequencer source. This interface is exposed by the sequencer source object.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSourceTopologyProvider']/*"/>
|
|
<msdn-id>ms699013</msdn-id>
|
|
<unmanaged>IMFMediaSourceTopologyProvider</unmanaged>
|
|
<unmanaged-short>IMFMediaSourceTopologyProvider</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSourceTopologyProvider.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaSourceTopologyProvider"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaSourceTopologyProvider.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaSourceTopologyProvider">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaSourceTopologyProvider"/>. (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.MediaFoundation.MediaSourceTopologyProvider.GetMediaSourceTopology(SharpDX.MediaFoundation.PresentationDescriptor,SharpDX.MediaFoundation.Topology@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Returns a topology for a media source that builds an internal topology.</p>
|
|
</summary>
|
|
<param name="presentationDescriptorRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/></strong> interface of the media source's presentation descriptor. To get this reference, either call <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.CreatePresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor@)"/></strong> on the media source, or get the reference from the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.NewPresentation"/> event.</p> </dd></param>
|
|
<param name="topologyOut"><dd> <p>Receives a reference to the topology's <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid argument. For example, a <strong><c>null</c></strong> input parameter, or the presentation descriptor is not valid.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaSourceTopologyProvider::GetMediaSourceTopology']/*"/>
|
|
<msdn-id>bb970383</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaSourceTopologyProvider::GetMediaSourceTopology([In, Optional] IMFPresentationDescriptor* pPresentationDescriptor,[Out] IMFTopology** ppTopology)</unmanaged>
|
|
<unmanaged-short>IMFMediaSourceTopologyProvider::GetMediaSourceTopology</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaStream">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Represents one stream in a media source. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Streams are created when a media source is started. For each stream, the media source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.NewStream"/> event with a reference to the stream's <strong><see cref="T:SharpDX.MediaFoundation.MediaStream"/></strong> interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaStream']/*"/>
|
|
<msdn-id>ms697561</msdn-id>
|
|
<unmanaged>IMFMediaStream</unmanaged>
|
|
<unmanaged-short>IMFMediaStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaStream.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaStream"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaStream.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaStream">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaStream"/>. (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.MediaFoundation.MediaStream.GetMediaSource(SharpDX.MediaFoundation.MediaSource@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a reference to the media source that created this media stream.</p>
|
|
</summary>
|
|
<param name="mediaSourceOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaSource"/></strong> interface of the media source. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media source's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaStream::GetMediaSource']/*"/>
|
|
<msdn-id>ms705668</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaStream::GetMediaSource([Out] IMFMediaSource** ppMediaSource)</unmanaged>
|
|
<unmanaged-short>IMFMediaStream::GetMediaSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaStream.GetStreamDescriptor(SharpDX.MediaFoundation.StreamDescriptor@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a stream descriptor for this media stream.</p>
|
|
</summary>
|
|
<param name="streamDescriptorOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.StreamDescriptor"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media source's <strong>Shutdown</strong> method has been called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Do not modify the stream descriptor. To change the presentation, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.CreatePresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor@)"/></strong> and modify the presentation descriptor.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaStream::GetStreamDescriptor']/*"/>
|
|
<msdn-id>ms697244</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaStream::GetStreamDescriptor([Out] IMFStreamDescriptor** ppStreamDescriptor)</unmanaged>
|
|
<unmanaged-short>IMFMediaStream::GetStreamDescriptor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaStream.RequestSample(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Requests a sample from the media source. </p>
|
|
</summary>
|
|
<param name="tokenRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface to an object that is used as a token for the request. The caller must implement this object. This parameter can be <strong><c>null</c></strong>. See Remarks.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_END_OF_STREAM</strong></dt> </dl> </td><td> <p> The end of the stream was reached. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_MEDIA_SOURCE_WRONGSTATE</strong></dt> </dl> </td><td> <p> The media source is stopped.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p> The source's <strong>Shutdown</strong> method has been called. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If <em>pToken</em> is not <strong><c>null</c></strong>, the media stream calls <strong>AddRef</strong> on <em>pToken</em> and places the token in a first-in, first-out queue.</p><p>When the next sample is available, the media stream stream does the following:</p><ol> <li> Pulls the first token from the queue. </li> <li> Sets the <strong><see cref="F:SharpDX.MediaFoundation.SampleAttributeKeys.Token"/></strong> attribute on the media sample. The attribute data is a reference to the token object. </li> <li> Sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.MediaSample"/> event. The event data is a reference to the media sample's <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface. </li> <li> Calls <strong>Release</strong> on the token. </li> </ol><p>If the media stream cannot fulfill the caller's request for a sample, it simply releases the token object and skips steps 2 and 3.</p><p>The caller should monitor the reference count on the request token. If the media stream sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.MediaSample"/> event, get the <strong><see cref="F:SharpDX.MediaFoundation.SampleAttributeKeys.Token"/></strong> attribute from the sample and match the attribute value against the token. If the token's reference count falls to zero and you did not receive an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.MediaSample"/> event, it means that the request was dropped.</p><p>Because the Media Foundation pipeline is multithreaded, the source's <strong>RequestSample</strong> method might get called after the source has stopped. If the media source is stopped, the method should return <strong>MF_E_MEDIA_SOURCE_WRONGSTATE</strong>. The pipeline does not treat this return code as an error condition. If the source returns any other error code, the pipeline treats it as fatal error and halts the session.</p><p><strong>Note</strong>??Earlier versions of the documentation listed the wrong error code for this case.</p><p>If the media source is paused, the method succeeds, but the stream does not deliver the sample until the source is started again.</p><p>If a media source enounters an error asynchronously while processing data, it should signal the error in one of the following ways (but not both):</p><ul> <li>Return an error code from the next <strong>RequestSample</strong> call.</li> <li>Send an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.Error"/> event.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaStream::RequestSample']/*"/>
|
|
<msdn-id>ms696240</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaStream::RequestSample([In] IUnknown* pToken)</unmanaged>
|
|
<unmanaged-short>IMFMediaStream::RequestSample</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaStream.MediaSource">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a reference to the media source that created this media stream.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaStream::GetMediaSource']/*"/>
|
|
<msdn-id>ms705668</msdn-id>
|
|
<unmanaged>GetMediaSource</unmanaged>
|
|
<unmanaged-short>GetMediaSource</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaStream::GetMediaSource([Out] IMFMediaSource** ppMediaSource)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaStream.StreamDescriptor">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a stream descriptor for this media stream.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Do not modify the stream descriptor. To change the presentation, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.CreatePresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor@)"/></strong> and modify the presentation descriptor.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaStream::GetStreamDescriptor']/*"/>
|
|
<msdn-id>ms697244</msdn-id>
|
|
<unmanaged>GetStreamDescriptor</unmanaged>
|
|
<unmanaged-short>GetStreamDescriptor</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaStream::GetStreamDescriptor([Out] IMFStreamDescriptor** ppStreamDescriptor)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaTypeHandler">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a media type from the object's list of supported media types.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Media types are returned in the approximate order of preference. The list of supported types is not guaranteed to be complete. To test whether a particular media type is supported, call <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.IsMediaTypeSupported(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType@)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaTypeHandler']/*"/>
|
|
<msdn-id>bb970473</msdn-id>
|
|
<unmanaged>IMFMediaTypeHandler</unmanaged>
|
|
<unmanaged-short>IMFMediaTypeHandler</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaTypeHandler.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaTypeHandler"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaTypeHandler.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MediaTypeHandler">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MediaTypeHandler"/>. (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.MediaFoundation.MediaTypeHandler.IsMediaTypeSupported(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p>Queries whether the object supports a specified media type. </p> <see cref="T:SharpDX.Result"/> IsMediaTypeSupported( <see cref="T:SharpDX.MediaFoundation.MediaType"/>* pMediaType, <see cref="T:SharpDX.MediaFoundation.MediaType"/>** ppMediaType
|
|
);<p></p>Parameters <p> pMediaType </p> <p>[in] Pointer to the <see cref="T:SharpDX.MediaFoundation.MediaType"/> Interface of the media type to check.</p> <p> ppMediaType </p> <p>[out] Receives a reference to the <see cref="T:SharpDX.MediaFoundation.MediaType"/> interface. This parameter can be <c>null</c>. See Remarks.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>MF_E_INVALIDMEDIATYPE</p> </td> <td> <p>The object does not support this media type.</p> </td> </tr></table> <p>If the object supports the media type given in pMediaType, the method returns <see cref="F:SharpDX.Result.Ok"/>. For a media source, it means the source can generate data that conforms to that media type. For a media sink, it means the sink can receive data that conforms to that media type. If the object does not support the media type, the method fails.</p> <p>The ppMediaType parameter is optional. If the method fails, the object might use ppMediaType to return a media type that the object does support, and which closely matches the one given in pMediaType. The method is not guaranteed to return a media type in ppMediaType. If no type is returned, this parameter receives a <c>null</c> reference. If the method succeeds, this parameter receives a <c>null</c> reference. If the caller sets ppMediaType to <c>null</c>, this parameter is ignored.</p> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFMediaTypeHandler Interface
|
|
</summary>
|
|
<param name="mediaTypeRef">No documentation.</param>
|
|
<param name="mediaTypeOut">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='IMFMediaTypeHandler::IsMediaTypeSupported']/*"/>
|
|
<msdn-id>ms701597</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaTypeHandler::IsMediaTypeSupported([In] IMFMediaType* pMediaType,[Out, Optional] IMFMediaType** ppMediaType)</unmanaged>
|
|
<unmanaged-short>IMFMediaTypeHandler::IsMediaTypeSupported</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaTypeHandler.GetMediaTypeCount(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of media types in the object's list of supported media types.</p>
|
|
</summary>
|
|
<param name="dwTypeCountRef"><dd> <p>Receives the number of media types in the list.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> To get the supported media types, call <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.GetMediaTypeByIndex(System.Int32,SharpDX.MediaFoundation.MediaType@)"/></strong>. </p><p> For a media source, the media type handler for each stream must contain at least one supported media type. For media sinks, the media type handler for each stream might contain zero media types. In that case, the application must provide the medai type. To test whether a particular media type is supported, call <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.IsMediaTypeSupported(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType@)"/></strong>. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaTypeHandler::GetMediaTypeCount']/*"/>
|
|
<msdn-id>bb970517</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaTypeHandler::GetMediaTypeCount([Out] unsigned int* pdwTypeCount)</unmanaged>
|
|
<unmanaged-short>IMFMediaTypeHandler::GetMediaTypeCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaTypeHandler.GetMediaTypeByIndex(System.Int32,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a media type from the object's list of supported media types.</p>
|
|
</summary>
|
|
<param name="dwIndex"><dd> <p> Zero-based index of the media type to retrieve. To get the number of media types in the list, call <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.GetMediaTypeCount(System.Int32@)"/></strong>. </p> </dd></param>
|
|
<param name="typeOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_MORE_TYPES</strong></dt> </dl> </td><td> <p> The <em>dwIndex</em> parameter is out of range. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Media types are returned in the approximate order of preference. The list of supported types is not guaranteed to be complete. To test whether a particular media type is supported, call <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.IsMediaTypeSupported(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType@)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaTypeHandler::GetMediaTypeByIndex']/*"/>
|
|
<msdn-id>bb970473</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaTypeHandler::GetMediaTypeByIndex([In] unsigned int dwIndex,[Out] IMFMediaType** ppType)</unmanaged>
|
|
<unmanaged-short>IMFMediaTypeHandler::GetMediaTypeByIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaTypeHandler.SetCurrentMediaType(SharpDX.MediaFoundation.MediaType)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the object's media type.</p>
|
|
</summary>
|
|
<param name="mediaTypeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the new media type.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p> Invalid request. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For media sources, setting the media type means the source will generate data that conforms to that media type. For media sinks, setting the media type means the sink can receive data that conforms to that media type.</p><p>Any implementation of this method should check whether <em>pMediaType</em> differs from the object's current media type. If the types are identical, the method should return <see cref="F:SharpDX.Result.Ok"/> but avoid releasing and recreating resources unnecessarily. If the types are not identical, the method should validate the new type.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaTypeHandler::SetCurrentMediaType']/*"/>
|
|
<msdn-id>bb970432</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaTypeHandler::SetCurrentMediaType([In] IMFMediaType* pMediaType)</unmanaged>
|
|
<unmanaged-short>IMFMediaTypeHandler::SetCurrentMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaTypeHandler.GetCurrentMediaType(SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the current media type of the object.</p>
|
|
</summary>
|
|
<param name="mediaTypeOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p> No media type is set. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaTypeHandler::GetCurrentMediaType']/*"/>
|
|
<msdn-id>bb970492</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaTypeHandler::GetCurrentMediaType([Out] IMFMediaType** ppMediaType)</unmanaged>
|
|
<unmanaged-short>IMFMediaTypeHandler::GetCurrentMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaTypeHandler.GetMajorType(System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the major media type of the object. </p>
|
|
</summary>
|
|
<param name="guidMajorTypeRef"><dd> <p>Receives a <see cref="T:System.Guid"/> that identifies the major type. For a list of possible values, see Major Media Types. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The major type identifies what kind of data is in the stream, such as audio or video. To get the specific details of the format, call <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.GetCurrentMediaType(SharpDX.MediaFoundation.MediaType@)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaTypeHandler::GetMajorType']/*"/>
|
|
<msdn-id>bb970337</msdn-id>
|
|
<unmanaged>HRESULT IMFMediaTypeHandler::GetMajorType([Out] GUID* pguidMajorType)</unmanaged>
|
|
<unmanaged-short>IMFMediaTypeHandler::GetMajorType</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaTypeHandler.MediaTypeCount">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of media types in the object's list of supported media types.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> To get the supported media types, call <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.GetMediaTypeByIndex(System.Int32,SharpDX.MediaFoundation.MediaType@)"/></strong>. </p><p> For a media source, the media type handler for each stream must contain at least one supported media type. For media sinks, the media type handler for each stream might contain zero media types. In that case, the application must provide the medai type. To test whether a particular media type is supported, call <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.IsMediaTypeSupported(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType@)"/></strong>. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaTypeHandler::GetMediaTypeCount']/*"/>
|
|
<msdn-id>bb970517</msdn-id>
|
|
<unmanaged>GetMediaTypeCount</unmanaged>
|
|
<unmanaged-short>GetMediaTypeCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaTypeHandler::GetMediaTypeCount([Out] unsigned int* pdwTypeCount)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaTypeHandler.CurrentMediaType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the current media type of the object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaTypeHandler::GetCurrentMediaType']/*"/>
|
|
<msdn-id>bb970492</msdn-id>
|
|
<unmanaged>GetCurrentMediaType</unmanaged>
|
|
<unmanaged-short>GetCurrentMediaType</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaTypeHandler::GetCurrentMediaType([Out] IMFMediaType** ppMediaType)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaTypeHandler.MajorType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the major media type of the object. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The major type identifies what kind of data is in the stream, such as audio or video. To get the specific details of the format, call <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.GetCurrentMediaType(SharpDX.MediaFoundation.MediaType@)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMediaTypeHandler::GetMajorType']/*"/>
|
|
<msdn-id>bb970337</msdn-id>
|
|
<unmanaged>GetMajorType</unmanaged>
|
|
<unmanaged-short>GetMajorType</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMediaTypeHandler::GetMajorType([Out] GUID* pguidMajorType)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Metadata">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets a list of the languages in which metadata is available.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> For more information about language tags, see RFC 1766, "Tags for the Identification of Languages". </p><p> To set the current language, call <strong><see cref="M:SharpDX.MediaFoundation.Metadata.SetLanguage(System.String)"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadata']/*"/>
|
|
<msdn-id>ms698736</msdn-id>
|
|
<unmanaged>IMFMetadata</unmanaged>
|
|
<unmanaged-short>IMFMetadata</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Metadata.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Metadata"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Metadata.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Metadata">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Metadata"/>. (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.MediaFoundation.Metadata.SetLanguage(System.String)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sets the language for setting and retrieving metadata. </p>
|
|
</summary>
|
|
<param name="wszRFC1766Ref"><dd> <p>Pointer to a null-terminated string containing an RFC 1766-compliant language tag.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>For more information about language tags, see RFC 1766, "Tags for the Identification of Languages".</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadata::SetLanguage']/*"/>
|
|
<msdn-id>ms703982</msdn-id>
|
|
<unmanaged>HRESULT IMFMetadata::SetLanguage([In] const wchar_t* pwszRFC1766)</unmanaged>
|
|
<unmanaged-short>IMFMetadata::SetLanguage</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Metadata.GetLanguage(System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the current language setting.</p>
|
|
</summary>
|
|
<param name="wszRFC1766Out"><dd> <p> Receives a reference to a null-terminated string containing an RFC 1766-compliant language tag. The caller must release the string by calling <strong>CoTaskMemFree</strong>. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>The metadata provider does not support multiple languages.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p> No language was set. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For more information about language tags, see RFC 1766, "Tags for the Identification of Languages."</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.Metadata.SetLanguage(System.String)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.Metadata.GetProperty(System.String,SharpDX.Win32.Variant@)"/></strong> methods set and get metadata for the current language setting.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadata::GetLanguage']/*"/>
|
|
<msdn-id>ms698978</msdn-id>
|
|
<unmanaged>HRESULT IMFMetadata::GetLanguage([Out] wchar_t** ppwszRFC1766)</unmanaged>
|
|
<unmanaged-short>IMFMetadata::GetLanguage</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Metadata.GetAllLanguages(SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets a list of the languages in which metadata is available.</p>
|
|
</summary>
|
|
<param name="vLanguagesOut"><dd> <p> A reference to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that receives the list of languages. The list is returned as an array of null-terminated wide-character strings. Each string in the array is an RFC 1766-compliant language tag. </p> <p>The returned <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type is VT_VECTOR | VT_LPWSTR. The list might be empty, if no language tags are present. The caller must free the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> by calling <strong>PropVariantClear</strong>. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> For more information about language tags, see RFC 1766, "Tags for the Identification of Languages". </p><p> To set the current language, call <strong><see cref="M:SharpDX.MediaFoundation.Metadata.SetLanguage(System.String)"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadata::GetAllLanguages']/*"/>
|
|
<msdn-id>ms698736</msdn-id>
|
|
<unmanaged>HRESULT IMFMetadata::GetAllLanguages([Out] PROPVARIANT* ppvLanguages)</unmanaged>
|
|
<unmanaged-short>IMFMetadata::GetAllLanguages</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Metadata.SetProperty(System.String,SharpDX.Win32.Variant)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sets the value of a metadata property. </p>
|
|
</summary>
|
|
<param name="wszNameRef"><dd> <p>Pointer to a null-terminated string containing the name of the property.</p> </dd></param>
|
|
<param name="vValueOut"><dd> <p>Pointer to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that contains the value of the property. For multivalued properties, use a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> with a VT_VECTOR type.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadata::SetProperty']/*"/>
|
|
<msdn-id>ms696972</msdn-id>
|
|
<unmanaged>HRESULT IMFMetadata::SetProperty([In] const wchar_t* pwszName,[In] const PROPVARIANT* ppvValue)</unmanaged>
|
|
<unmanaged-short>IMFMetadata::SetProperty</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Metadata.GetProperty(System.String,SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the value of a metadata property.</p>
|
|
</summary>
|
|
<param name="wszNameRef"><dd> <p> A reference to a null-terminated string that containings the name of the property. To get the list of property names, call <strong><see cref="M:SharpDX.MediaFoundation.Metadata.GetAllPropertyNames(SharpDX.Win32.Variant@)"/></strong>.</p> </dd></param>
|
|
<param name="vValueOut"><dd> <p> Pointer to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that receives the value of the property. The <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type depends on the property. For multivalued properties, the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> is a <strong>VT_VECTOR</strong> type. The caller must free the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> by calling <strong>PropVariantClear</strong>. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_PROPERTY_NOT_FOUND</strong></dt> </dl> </td><td> <p> The requested property was not found. </p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadata::GetProperty']/*"/>
|
|
<msdn-id>ms694844</msdn-id>
|
|
<unmanaged>HRESULT IMFMetadata::GetProperty([In] const wchar_t* pwszName,[Out] PROPVARIANT* ppvValue)</unmanaged>
|
|
<unmanaged-short>IMFMetadata::GetProperty</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Metadata.DeleteProperty(System.String)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Deletes a metadata property.</p>
|
|
</summary>
|
|
<param name="wszNameRef"><dd> <p>Pointer to a null-terminated string containing the name of the property.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_PROPERTY_NOT_FOUND</strong></dt> </dl> </td><td> <p> The property was not found. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For a media source, deleting a property from the metadata collection does not change the original content.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadata::DeleteProperty']/*"/>
|
|
<msdn-id>ms699021</msdn-id>
|
|
<unmanaged>HRESULT IMFMetadata::DeleteProperty([In] const wchar_t* pwszName)</unmanaged>
|
|
<unmanaged-short>IMFMetadata::DeleteProperty</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Metadata.GetAllPropertyNames(SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets a list of all the metadata property names on this object.</p>
|
|
</summary>
|
|
<param name="vNamesOut"><dd> <p>Pointer to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that receives an array of null-terminated wide-character strings. If no properties are available, the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type is VT_EMPTY. Otherwise, the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type is VT_VECTOR | VT_LPWSTR. The caller must free the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> by calling <strong>PropVariantClear</strong>.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadata::GetAllPropertyNames']/*"/>
|
|
<msdn-id>ms704581</msdn-id>
|
|
<unmanaged>HRESULT IMFMetadata::GetAllPropertyNames([Out] PROPVARIANT* ppvNames)</unmanaged>
|
|
<unmanaged-short>IMFMetadata::GetAllPropertyNames</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Metadata.AllLanguages">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets a list of the languages in which metadata is available.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> For more information about language tags, see RFC 1766, "Tags for the Identification of Languages". </p><p> To set the current language, call <strong><see cref="M:SharpDX.MediaFoundation.Metadata.SetLanguage(System.String)"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadata::GetAllLanguages']/*"/>
|
|
<msdn-id>ms698736</msdn-id>
|
|
<unmanaged>GetAllLanguages</unmanaged>
|
|
<unmanaged-short>GetAllLanguages</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMetadata::GetAllLanguages([Out] PROPVARIANT* ppvLanguages)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Metadata.AllPropertyNames">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets a list of all the metadata property names on this object.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadata::GetAllPropertyNames']/*"/>
|
|
<msdn-id>ms704581</msdn-id>
|
|
<unmanaged>GetAllPropertyNames</unmanaged>
|
|
<unmanaged-short>GetAllPropertyNames</unmanaged-short>
|
|
<unmanaged>HRESULT IMFMetadata::GetAllPropertyNames([Out] PROPVARIANT* ppvNames)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MetadataProvider">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets metadata from a media source or other object.</p><p>If a media source supports this interface, it must expose the interface as a service. To get a reference to this interface from a media source, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <strong>MF_METADATA_PROVIDER_SERVICE</strong>. Other types of object can expose this interface through <strong>QueryInterface</strong>.</p><p>Use this interface to get a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Metadata"/></strong> interface.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadataProvider']/*"/>
|
|
<msdn-id>ms705606</msdn-id>
|
|
<unmanaged>IMFMetadataProvider</unmanaged>
|
|
<unmanaged-short>IMFMetadataProvider</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MetadataProvider.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MetadataProvider"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MetadataProvider.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.MetadataProvider">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.MetadataProvider"/>. (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.MediaFoundation.MetadataProvider.GetMFMetadata(SharpDX.MediaFoundation.PresentationDescriptor,System.Int32,System.Int32,SharpDX.MediaFoundation.Metadata@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets a collection of metadata, either for an entire presentation, or for one stream in the presentation.</p>
|
|
</summary>
|
|
<param name="presentationDescriptorRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/></strong> interface of the media source's presentation descriptor. </p> </dd></param>
|
|
<param name="dwStreamIdentifier"><dd> <p> If this parameter is zero, the method retrieves metadata that applies to the entire presentation. Otherwise, this <em></em> parameter specifies a stream identifier, and the method retrieves metadata for that stream. To get the stream identifier for a stream, call <strong><see cref="M:SharpDX.MediaFoundation.StreamDescriptor.GetStreamIdentifier(System.Int32@)"/></strong>. </p> </dd></param>
|
|
<param name="dwFlags"><dd> <p> Reserved. Must be zero. </p> </dd></param>
|
|
<param name="mFMetadataOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Metadata"/></strong> interface. Use this interface to access the metadata. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_PROPERTY_NOT_FOUND</strong></dt> </dl> </td><td> <p>No metadata is available for the requested stream or presentation.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFMetadataProvider::GetMFMetadata']/*"/>
|
|
<msdn-id>ms694097</msdn-id>
|
|
<unmanaged>HRESULT IMFMetadataProvider::GetMFMetadata([In, Optional] IMFPresentationDescriptor* pPresentationDescriptor,[In] unsigned int dwStreamIdentifier,[In] unsigned int dwFlags,[Out] IMFMetadata** ppMFMetadata)</unmanaged>
|
|
<unmanaged-short>IMFMetadataProvider::GetMFMetadata</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Mfasyncresult">
|
|
<summary>
|
|
<p>This topic describes how to implement the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface.</p><p>It is rare that you will need to write a custom implementation of the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. In almost all cases, the standard Media Foundation implementation is sufficient. (This implementation is returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAsyncResult(SharpDX.ComObject,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.MediaFoundation.AsyncResult@)"/></strong> function.) However, if you do write a custom implementation, there are some issues to be aware of.</p><p>First, your implementation must inherit the <strong><see cref="T:SharpDX.MediaFoundation.Mfasyncresult"/></strong> structure. The Media Foundation work queues use this structure internally to dispatch the operation. Initialize all of the structure members to zero, except for the <strong>pCallback</strong> member, which contains a reference to the caller's callback interface.</p><p>Second, your object should call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LockPlatform"/></strong> in its constructor, to lock the Media Foundation platform. Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockPlatform"/></strong> to unlock the platform. These functions help to prevent the platform from shutting down before the object is destroyed. For more information, see Work Queues.</p><p>The following code shows a basic implementation of the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. As shown, this code provides no additional features beyond the standard Media Foundation implementation. </p><pre>///////////////////////////////////////////////////////////////////////////////
|
|
// CMyAsyncResult
|
|
//
|
|
// Custom implementation of <see cref="T:SharpDX.MediaFoundation.AsyncResult"/>. All implementations of this
|
|
// interface must inherit the <see cref="T:SharpDX.MediaFoundation.Mfasyncresult"/> structure.
|
|
//
|
|
/////////////////////////////////////////////////////////////////////////////// class CMyAsyncResult : public <see cref="T:SharpDX.MediaFoundation.Mfasyncresult"/>
|
|
{
|
|
protected: LONG m_cRef; // Reference count. <see cref="T:System.Boolean"/> m_bLockPlatform; // Locked the Media Foundation platform? <see cref="T:SharpDX.ComObject"/>* m_pState; // Caller's state object. <see cref="T:SharpDX.ComObject"/>* m_pObject; // Optional object. See <see cref="M:SharpDX.MediaFoundation.AsyncResult.GetObjectW(SharpDX.ComObject@)"/>. // Constructor. CMyAsyncResult(<see cref="T:SharpDX.MediaFoundation.AsyncCallback"/> *pCallback, <see cref="T:SharpDX.ComObject"/> *pState, <see cref="T:SharpDX.Result"/> *phr) : m_cRef(1), m_bLockPlatform(<see cref="F:SharpDX.Result.False"/>), m_pObject(<c>null</c>), m_pState(pState) { *phr = <see cref="M:SharpDX.MediaFoundation.MediaFactory.LockPlatform"/>(); m_bLockPlatform = TRUE; // Initialize the <see cref="T:SharpDX.MediaFoundation.Mfasyncresult"/> members. ZeroMemory(&this->overlapped, sizeof(OVERLAPPED)); hrStatusResult = <see cref="F:SharpDX.Result.Ok"/>; dwBytesTransferred = 0; hEvent = <c>null</c>; this->pCallback = pCallback; if (pCallback) { this->pCallback->AddRef(); } if (m_pState) { m_pState->AddRef(); } } virtual ~CMyAsyncResult() { SafeRelease(&pCallback); SafeRelease(&m_pState); SafeRelease(&m_pObject); if (m_bLockPlatform) { <see cref="M:SharpDX.MediaFoundation.MediaFactory.UnlockPlatform"/>(); } } public: // Static method to create an instance of this object. static <see cref="T:SharpDX.Result"/> CreateInstance( <see cref="T:SharpDX.MediaFoundation.AsyncCallback"/> *pCallback, // Callback to invoke. <see cref="T:SharpDX.ComObject"/> *pState, // Optional state object. CMyAsyncResult **ppResult // Receives a reference to the object. ) { <see cref="T:SharpDX.Result"/> hr = <see cref="F:SharpDX.Result.Ok"/>; *ppResult = <c>null</c>; CMyAsyncResult *pResult = new (std::nothrow) CMyAsyncResult(pCallback, pState, &hr); if (pResult == <c>null</c>) { return E_OUTOFMEMORY; } if (FAILED(hr)) { delete pResult; return hr; } // If the callback is <c>null</c>, create an event that will be signaled. if (pCallback == <c>null</c>) { pResult->hEvent = CreateEvent(<c>null</c>, <see cref="F:SharpDX.Result.False"/>, <see cref="F:SharpDX.Result.False"/>, <c>null</c>); if (pResult->hEvent == <c>null</c>) { hr = HRESULT_FROM_WIN32(GetLastError()); } } if (SUCCEEDED(hr)) { *ppResult = pResult; // Return the reference to the caller. } else { pResult->Release(); } return hr; } // SetObject: Sets the optional result object. // (This method is not part of the interface.) <see cref="T:SharpDX.Result"/> SetObject(<see cref="T:SharpDX.ComObject"/> *pObject) { SafeRelease(&m_pObject); m_pObject = pObject; if (pObject) { m_pObject->AddRef(); } return <see cref="F:SharpDX.Result.Ok"/>; } // <see cref="T:SharpDX.ComObject"/> methods. STDMETHODIMP QueryInterface(REFIID riid, void **ppv) { static const QITAB qit[] = { QITABENT(CMyAsyncResult, <see cref="T:SharpDX.MediaFoundation.AsyncResult"/>), { 0 } }; return QISearch(this, qit, riid, ppv); } STDMETHODIMP_(ULONG) AddRef() { return InterlockedIncrement(&m_cRef); } STDMETHODIMP_(ULONG) Release() { LONG cRef = InterlockedDecrement(&m_cRef); if (cRef == 0) { delete this; } return cRef; } // <see cref="T:SharpDX.MediaFoundation.AsyncResult"/> methods. STDMETHODIMP GetState(<see cref="T:SharpDX.ComObject"/>** ppunkState) { if (ppunkState == <c>null</c>) { return E_POINTER; } *ppunkState = m_pState; if (m_pState) { (*ppunkState)->AddRef(); } return <see cref="F:SharpDX.Result.Ok"/>; } STDMETHODIMP GetStatus( void) { return hrStatusResult; } STDMETHODIMP STDMETHODCALLTYPE SetStatus(<see cref="T:SharpDX.Result"/> hrStatus) { hrStatusResult = hrStatus; return <see cref="F:SharpDX.Result.Ok"/>; } STDMETHODIMP GetObject(<see cref="T:SharpDX.ComObject"/> **ppObject) { if (ppObject == <c>null</c>) { return E_POINTER; } *ppObject = m_pObject; if (m_pObject) { (*ppObject)->AddRef(); } return <see cref="F:SharpDX.Result.Ok"/>; } <see cref="T:SharpDX.ComObject"/>* STDMETHODCALLTYPE GetStateNoAddRef() { return m_pState; // Warning! Can be <c>null</c>. }
|
|
};
|
|
</pre>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFASYNCRESULT']/*"/>
|
|
<msdn-id>aa370805</msdn-id>
|
|
<unmanaged>MFASYNCRESULT</unmanaged>
|
|
<unmanaged-short>MFASYNCRESULT</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Mfasyncresult.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Mfasyncresult"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Mfasyncresult.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Mfasyncresult">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Mfasyncresult"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
|
|
</summary>
|
|
<param name="nativePointer">The native pointer.</param>
|
|
<returns>
|
|
The result of the conversion.
|
|
</returns>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetCredential">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the password.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the password is not available, the method might succeed and set *<em>pcbData</em> to zero.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredential']/*"/>
|
|
<msdn-id>ms702055</msdn-id>
|
|
<unmanaged>IMFNetCredential</unmanaged>
|
|
<unmanaged-short>IMFNetCredential</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredential.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.NetCredential"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredential.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.NetCredential">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.NetCredential"/>. (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.MediaFoundation.NetCredential.SetUser(System.Byte[],System.Int32,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the user name.</p>
|
|
</summary>
|
|
<param name="bDataRef"><dd> <p>Pointer to a buffer that contains the user name. If <em>fDataIsEncrypted</em> is <strong><see cref="F:SharpDX.Result.False"/></strong>, the buffer is a wide-character string. Otherwise, the buffer contains encrypted data.</p> </dd></param>
|
|
<param name="cbData"><dd> <p>Size of <em>pbData</em>, in bytes. If <em>fDataIsEncrypted</em> is <strong><see cref="F:SharpDX.Result.False"/></strong>, the size includes the terminating null character.</p> </dd></param>
|
|
<param name="fDataIsEncrypted"><dd> <p>If <strong>TRUE</strong>, the user name is encrypted. Otherwise, the user name is not encrypted.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredential::SetUser']/*"/>
|
|
<msdn-id>ms693551</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredential::SetUser([In, Buffer] unsigned char* pbData,[In] unsigned int cbData,[In] BOOL fDataIsEncrypted)</unmanaged>
|
|
<unmanaged-short>IMFNetCredential::SetUser</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredential.SetPassword(System.Byte[],System.Int32,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the password.</p>
|
|
</summary>
|
|
<param name="bDataRef"><dd> <p>Pointer to a buffer that contains the password. If <em>fDataIsEncrypted</em> is <strong><see cref="F:SharpDX.Result.False"/></strong>, the buffer is a wide-character string. Otherwise, the buffer contains encrypted data.</p> </dd></param>
|
|
<param name="cbData"><dd> <p>Size of <em>pbData</em>, in bytes. If <em>fDataIsEncrypted</em> is <strong><see cref="F:SharpDX.Result.False"/></strong>, the size includes the terminating null character.</p> </dd></param>
|
|
<param name="fDataIsEncrypted"><dd> <p>If <strong>TRUE</strong>, the password is encrypted. Otherwise, the password is not encrypted.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredential::SetPassword']/*"/>
|
|
<msdn-id>ms699838</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredential::SetPassword([In, Buffer] unsigned char* pbData,[In] unsigned int cbData,[In] BOOL fDataIsEncrypted)</unmanaged>
|
|
<unmanaged-short>IMFNetCredential::SetPassword</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredential.GetUser(System.Byte[],System.Int32@,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the user name.</p>
|
|
</summary>
|
|
<param name="bDataRef"><dd> <p>Pointer to a buffer that receives the user name. To find the required buffer size, set this parameter to <strong><c>null</c></strong>. If <em>fEncryptData</em> is <strong><see cref="F:SharpDX.Result.False"/></strong>, the buffer contains a wide-character string. Otherwise, the buffer contains encrypted data.</p> </dd></param>
|
|
<param name="cbDataRef"><dd> <p>On input, specifies the size of the <em>pbData</em> buffer, in bytes. On output, receives the required buffer size. If <em>fEncryptData</em> is <strong><see cref="F:SharpDX.Result.False"/></strong>, the size includes the terminating null character.</p> </dd></param>
|
|
<param name="fEncryptData"><dd> <p>If <strong>TRUE</strong>, the method returns an encrypted string. Otherwise, the method returns an unencrypted string.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the user name is not available, the method might succeed and set *<em>pcbData</em> to zero.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredential::GetUser']/*"/>
|
|
<msdn-id>ms694290</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredential::GetUser([Out, Buffer, Optional] unsigned char* pbData,[InOut] unsigned int* pcbData,[In] BOOL fEncryptData)</unmanaged>
|
|
<unmanaged-short>IMFNetCredential::GetUser</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredential.GetPassword(System.Byte[],System.Int32@,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the password.</p>
|
|
</summary>
|
|
<param name="bDataRef"><dd> <p>Pointer to a buffer that receives the password. To find the required buffer size, set this parameter to <strong><c>null</c></strong>. If <em>fEncryptData</em> is <strong><see cref="F:SharpDX.Result.False"/></strong>, the buffer contains a wide-character string. Otherwise, the buffer contains encrypted data.</p> </dd></param>
|
|
<param name="cbDataRef"><dd> <p>On input, specifies the size of the <em>pbData</em> buffer, in bytes. On output, receives the required buffer size. If <em>fEncryptData</em> is <strong><see cref="F:SharpDX.Result.False"/></strong>, the size includes the terminating null character.</p> </dd></param>
|
|
<param name="fEncryptData"><dd> <p>If <strong>TRUE</strong>, the method returns an encrypted string. Otherwise, the method returns an unencrypted string.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the password is not available, the method might succeed and set *<em>pcbData</em> to zero.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredential::GetPassword']/*"/>
|
|
<msdn-id>ms702055</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredential::GetPassword([Out, Buffer, Optional] unsigned char* pbData,[InOut] unsigned int* pcbData,[In] BOOL fEncryptData)</unmanaged>
|
|
<unmanaged-short>IMFNetCredential::GetPassword</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredential.LoggedOnUser(System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Queries whether logged-on credentials should be used.</p>
|
|
</summary>
|
|
<param name="fLoggedOnUserRef"><dd> <p>Receives a Boolean value. If logged-on credentials should be used, the value is <strong>TRUE</strong>. Otherwise, the value is <strong><see cref="F:SharpDX.Result.False"/></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredential::LoggedOnUser']/*"/>
|
|
<msdn-id>ms698960</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredential::LoggedOnUser([Out] BOOL* pfLoggedOnUser)</unmanaged>
|
|
<unmanaged-short>IMFNetCredential::LoggedOnUser</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetCredentialCache">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Specifies how user credentials are stored.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If no flags are specified, the credentials are cached in memory. This method can be implemented by the credential manager and called by the network source.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredentialCache']/*"/>
|
|
<msdn-id>ms693547</msdn-id>
|
|
<unmanaged>IMFNetCredentialCache</unmanaged>
|
|
<unmanaged-short>IMFNetCredentialCache</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredentialCache.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.NetCredentialCache"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredentialCache.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.NetCredentialCache">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.NetCredentialCache"/>. (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.MediaFoundation.NetCredentialCache.GetCredential(System.String,System.String,System.Int32,SharpDX.MediaFoundation.NetCredential@,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the credential object for the specified URL.</p>
|
|
</summary>
|
|
<param name="szUrlRef"><dd> <p>A null-terminated wide-character string containing the URL for which the credential is needed.</p> </dd></param>
|
|
<param name="szRealmRef"><dd> <p>A null-terminated wide-character string containing the realm for the authentication.</p> </dd></param>
|
|
<param name="dwAuthenticationFlags"><dd> <p>Bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.NetAuthenticationFlags"/></strong> enumeration.</p> </dd></param>
|
|
<param name="credOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.NetCredential"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<param name="dwRequirementsFlagsRef"><dd> <p>Receives a bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialRequirements"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredentialCache::GetCredential']/*"/>
|
|
<msdn-id>ms699842</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredentialCache::GetCredential([In] const wchar_t* pszUrl,[In] const wchar_t* pszRealm,[In] unsigned int dwAuthenticationFlags,[Out] IMFNetCredential** ppCred,[Out] unsigned int* pdwRequirementsFlags)</unmanaged>
|
|
<unmanaged-short>IMFNetCredentialCache::GetCredential</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredentialCache.SetGood(SharpDX.MediaFoundation.NetCredential,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Reports whether the credential object provided successfully passed the authentication challenge.</p>
|
|
</summary>
|
|
<param name="credRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.NetCredential"/></strong> interface.</p> </dd></param>
|
|
<param name="fGood"><dd> <p><strong>TRUE</strong> if the credential object succeeded in the authentication challenge; otherwise, <strong><see cref="F:SharpDX.Result.False"/></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is called by the network source into the credential manager.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredentialCache::SetGood']/*"/>
|
|
<msdn-id>ms704649</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredentialCache::SetGood([In] IMFNetCredential* pCred,[In] BOOL fGood)</unmanaged>
|
|
<unmanaged-short>IMFNetCredentialCache::SetGood</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredentialCache.SetUserOptions(SharpDX.MediaFoundation.NetCredential,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Specifies how user credentials are stored.</p>
|
|
</summary>
|
|
<param name="credRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.NetCredential"/></strong> interface. Obtain this reference by calling <strong><see cref="M:SharpDX.MediaFoundation.NetCredentialCache.GetCredential(System.String,System.String,System.Int32,SharpDX.MediaFoundation.NetCredential@,System.Int32@)"/></strong>.</p> </dd></param>
|
|
<param name="dwOptionsFlags"><dd> <p>Bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialOptions"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If no flags are specified, the credentials are cached in memory. This method can be implemented by the credential manager and called by the network source.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredentialCache::SetUserOptions']/*"/>
|
|
<msdn-id>ms693547</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredentialCache::SetUserOptions([In] IMFNetCredential* pCred,[In] unsigned int dwOptionsFlags)</unmanaged>
|
|
<unmanaged-short>IMFNetCredentialCache::SetUserOptions</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetCredentialManager">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Implemented by applications to provide user credentials for a network source.</p><p>To use this interface, implement it in your application. Then create a property store object and set the <strong>MFNETSOURCE_CREDENTIAL_MANAGER</strong> property. The value of the property is a reference to your application's <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/></strong> interface. Then pass the property store to one of the source resolver's creation functions, such as <strong><see cref="M:SharpDX.MediaFoundation.SourceResolver.CreateObjectFromURL(System.String,System.Int32,SharpDX.ComObject,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong>, in the <em>pProps</em> parameter.</p><p>Media Foundation does not provide a default implementation of this interface. Applications that support authentication must implement this interface.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredentialManager']/*"/>
|
|
<msdn-id>ms693499</msdn-id>
|
|
<unmanaged>IMFNetCredentialManager</unmanaged>
|
|
<unmanaged-short>IMFNetCredentialManager</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredentialManager.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredentialManager.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.NetCredentialManager">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.NetCredentialManager"/>. (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.MediaFoundation.NetCredentialManager.BeginGetCredentials(SharpDX.MediaFoundation.NetCredentialManagerGetParam@,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Begins an asynchronous request to retrieve the user's credentials.</p>
|
|
</summary>
|
|
<param name="paramRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.NetCredentialManagerGetParam"/></strong> structure.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface.</p> </dd></param>
|
|
<param name="stateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredentialManager::BeginGetCredentials']/*"/>
|
|
<msdn-id>ms705663</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredentialManager::BeginGetCredentials([In] MFNetCredentialManagerGetParam* pParam,[In] IMFAsyncCallback* pCallback,[In] IUnknown* pState)</unmanaged>
|
|
<unmanaged-short>IMFNetCredentialManager::BeginGetCredentials</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredentialManager.EndGetCredentials(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.NetCredential@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Completes an asynchronous request to retrieve the user's credentials.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface that contains the asynchronous result.</p> </dd></param>
|
|
<param name="credOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.NetCredential"/></strong> interface, which is used to retrieve the credentials. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredentialManager::EndGetCredentials']/*"/>
|
|
<msdn-id>ms701589</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredentialManager::EndGetCredentials([In] IMFAsyncResult* pResult,[Out] IMFNetCredential** ppCred)</unmanaged>
|
|
<unmanaged-short>IMFNetCredentialManager::EndGetCredentials</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetCredentialManager.SetGood(SharpDX.MediaFoundation.NetCredential,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Specifies whether the user's credentials succeeded in the authentication challenge. The network source calls this method to informs the application whether the user's credentials were authenticated.</p>
|
|
</summary>
|
|
<param name="credRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.NetCredential"/></strong> interface.</p> </dd></param>
|
|
<param name="fGood"><dd> <p>Boolean value. The value is <strong>TRUE</strong> if the credentials succeeded in the authentication challenge. Otherwise, the value is <strong><see cref="F:SharpDX.Result.False"/></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetCredentialManager::SetGood']/*"/>
|
|
<msdn-id>ms705614</msdn-id>
|
|
<unmanaged>HRESULT IMFNetCredentialManager::SetGood([In] IMFNetCredential* pCred,[In] BOOL fGood)</unmanaged>
|
|
<unmanaged-short>IMFNetCredentialManager::SetGood</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetProxyLocator">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Determines the next proxy to use.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetProxyLocator']/*"/>
|
|
<msdn-id>ms700807</msdn-id>
|
|
<unmanaged>IMFNetProxyLocator</unmanaged>
|
|
<unmanaged-short>IMFNetProxyLocator</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetProxyLocator.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.NetProxyLocator"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetProxyLocator.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.NetProxyLocator">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.NetProxyLocator"/>. (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.MediaFoundation.NetProxyLocator.FindFirstProxy(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Initializes the proxy locator object.</p>
|
|
</summary>
|
|
<param name="szHostRef"><dd> <p>Null-terminated wide-character string containing the hostname of the destination server.</p> </dd></param>
|
|
<param name="szUrlRef"><dd> <p>Null-terminated wide-character string containing the destination URL.</p> </dd></param>
|
|
<param name="fReserved"><dd> <p>Reserved. Set to <strong><see cref="F:SharpDX.Result.False"/></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetProxyLocator::FindFirstProxy']/*"/>
|
|
<msdn-id>ms697016</msdn-id>
|
|
<unmanaged>HRESULT IMFNetProxyLocator::FindFirstProxy([In] const wchar_t* pszHost,[In] const wchar_t* pszUrl,[In] BOOL fReserved)</unmanaged>
|
|
<unmanaged-short>IMFNetProxyLocator::FindFirstProxy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetProxyLocator.FindNextProxy">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Determines the next proxy to use.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>S_FALSE</strong></dt> </dl> </td><td> <p>There are no more proxy objects.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetProxyLocator::FindNextProxy']/*"/>
|
|
<msdn-id>ms700807</msdn-id>
|
|
<unmanaged>HRESULT IMFNetProxyLocator::FindNextProxy()</unmanaged>
|
|
<unmanaged-short>IMFNetProxyLocator::FindNextProxy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetProxyLocator.RegisterProxyResult(SharpDX.Result)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Keeps a record of the success or failure of using the current proxy.</p>
|
|
</summary>
|
|
<param name="hrOp"><dd> <p><strong><see cref="T:SharpDX.Result"/></strong> specifying the result of using the current proxy for connection.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetProxyLocator::RegisterProxyResult']/*"/>
|
|
<msdn-id>ms696180</msdn-id>
|
|
<unmanaged>HRESULT IMFNetProxyLocator::RegisterProxyResult([In] HRESULT hrOp)</unmanaged>
|
|
<unmanaged-short>IMFNetProxyLocator::RegisterProxyResult</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetProxyLocator.GetCurrentProxy(System.IntPtr,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the current proxy information including hostname and port.</p>
|
|
</summary>
|
|
<param name="szStrRef"><dd> <p>Pointer to a buffer that receives a null-terminated string containing the proxy hostname and port. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="cchStrRef"><dd> <p>On input, specifies the number of elements in the <em>pszStr</em> array. On output, receives the required size of the buffer.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOT_SUFFICIENT_BUFFER</strong></dt> </dl> </td><td> <p>The buffer specified in <em>pszStr</em> is too small.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetProxyLocator::GetCurrentProxy']/*"/>
|
|
<msdn-id>ms697327</msdn-id>
|
|
<unmanaged>HRESULT IMFNetProxyLocator::GetCurrentProxy([Out, Buffer, Optional] wchar_t* pszStr,[In] unsigned int* pcchStr)</unmanaged>
|
|
<unmanaged-short>IMFNetProxyLocator::GetCurrentProxy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetProxyLocator.Clone(SharpDX.MediaFoundation.NetProxyLocator@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates a new instance of the default proxy locator.</p>
|
|
</summary>
|
|
<param name="proxyLocatorOut"><dd> <p>Receives a reference to the new proxy locator object's <strong><see cref="T:SharpDX.MediaFoundation.NetProxyLocator"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetProxyLocator::Clone']/*"/>
|
|
<msdn-id>ms697210</msdn-id>
|
|
<unmanaged>HRESULT IMFNetProxyLocator::Clone([In] IMFNetProxyLocator** ppProxyLocator)</unmanaged>
|
|
<unmanaged-short>IMFNetProxyLocator::Clone</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetProxyLocatorFactory">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Creates a proxy locator object, which determines the proxy to use.</p><p>The network source uses this interface to create the proxy locator object. Applications can provide their own implementation of this interface by setting the <strong>MFNETSOURCE_PROXYLOCATORFACTORY</strong> property. on the source resolver. If the application does not set this property, the network source uses the default proxy locator provided by Media Foundation.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetProxyLocatorFactory']/*"/>
|
|
<msdn-id>ms698907</msdn-id>
|
|
<unmanaged>IMFNetProxyLocatorFactory</unmanaged>
|
|
<unmanaged-short>IMFNetProxyLocatorFactory</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetProxyLocatorFactory.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.NetProxyLocatorFactory"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetProxyLocatorFactory.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.NetProxyLocatorFactory">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.NetProxyLocatorFactory"/>. (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.MediaFoundation.NetProxyLocatorFactory.CreateProxyLocator(System.String,SharpDX.MediaFoundation.NetProxyLocator@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates an <strong><see cref="T:SharpDX.MediaFoundation.NetProxyLocator"/></strong> interface proxy locator object based on the protocol name.</p>
|
|
</summary>
|
|
<param name="szProtocolRef">No documentation.</param>
|
|
<param name="proxyLocatorOut">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetProxyLocatorFactory::CreateProxyLocator']/*"/>
|
|
<msdn-id>ms694154</msdn-id>
|
|
<unmanaged>HRESULT IMFNetProxyLocatorFactory::CreateProxyLocator([In] const wchar_t* pszProtocol,[Out] IMFNetProxyLocator** ppProxyLocator)</unmanaged>
|
|
<unmanaged-short>IMFNetProxyLocatorFactory::CreateProxyLocator</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetResourceFilter">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Called when the byte stream redirects to a URL.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetResourceFilter']/*"/>
|
|
<msdn-id>hh448041</msdn-id>
|
|
<unmanaged>IMFNetResourceFilter</unmanaged>
|
|
<unmanaged-short>IMFNetResourceFilter</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetResourceFilter.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.NetResourceFilter"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetResourceFilter.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.NetResourceFilter">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.NetResourceFilter"/>. (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.MediaFoundation.NetResourceFilter.OnRedirect(System.String,System.Int16@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Called when the byte stream redirects to a URL.</p>
|
|
</summary>
|
|
<param name="szUrlRef"><dd> <p>The URL to which the connection has been redirected.</p> </dd></param>
|
|
<param name="vbCancelRef"><dd> <p>To cancel the redirection, set this parameter to <strong>VARIANT_TRUE</strong>. To allow the redirection, set this parameter to <strong>VARIANT_FALSE</strong>.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetResourceFilter::OnRedirect']/*"/>
|
|
<msdn-id>hh448041</msdn-id>
|
|
<unmanaged>HRESULT IMFNetResourceFilter::OnRedirect([In] const wchar_t* pszUrl,[Out] short* pvbCancel)</unmanaged>
|
|
<unmanaged-short>IMFNetResourceFilter::OnRedirect</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetResourceFilter.OnSendingRequest(System.String)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Called when the byte stream requests a URL.</p>
|
|
</summary>
|
|
<param name="szUrlRef"><dd> <p>The URL that the byte stream is requesting.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetResourceFilter::OnSendingRequest']/*"/>
|
|
<msdn-id>hh448042</msdn-id>
|
|
<unmanaged>HRESULT IMFNetResourceFilter::OnSendingRequest([In] const wchar_t* pszUrl)</unmanaged>
|
|
<unmanaged-short>IMFNetResourceFilter::OnSendingRequest</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetSchemeHandlerConfig">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves a supported protocol by index</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetSchemeHandlerConfig']/*"/>
|
|
<msdn-id>ms697058</msdn-id>
|
|
<unmanaged>IMFNetSchemeHandlerConfig</unmanaged>
|
|
<unmanaged-short>IMFNetSchemeHandlerConfig</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetSchemeHandlerConfig.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.NetSchemeHandlerConfig"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetSchemeHandlerConfig.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.NetSchemeHandlerConfig">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.NetSchemeHandlerConfig"/>. (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.MediaFoundation.NetSchemeHandlerConfig.GetNumberOfSupportedProtocols(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of protocols supported by the network scheme plug-in.</p>
|
|
</summary>
|
|
<param name="cProtocolsRef"><dd> <p>Receives the number of protocols.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetSchemeHandlerConfig::GetNumberOfSupportedProtocols']/*"/>
|
|
<msdn-id>ms701625</msdn-id>
|
|
<unmanaged>HRESULT IMFNetSchemeHandlerConfig::GetNumberOfSupportedProtocols([Out] unsigned int* pcProtocols)</unmanaged>
|
|
<unmanaged-short>IMFNetSchemeHandlerConfig::GetNumberOfSupportedProtocols</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetSchemeHandlerConfig.GetSupportedProtocolType(System.Int32,SharpDX.MediaFoundation.NetsourceProtocolType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves a supported protocol by index</p>
|
|
</summary>
|
|
<param name="nProtocolIndex"><dd> <p>Zero-based index of the protocol to retrieve. To get the number of supported protocols, call <strong><see cref="M:SharpDX.MediaFoundation.NetSchemeHandlerConfig.GetNumberOfSupportedProtocols(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<param name="nProtocolTypeRef"><dd> <p>Receives a member of the <strong><see cref="T:SharpDX.MediaFoundation.NetsourceProtocolType"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The value passed in the <em>nProtocolIndex</em> parameter was greater than the total number of supported protocols, returned by <strong>GetNumberOfSupportedProtocols</strong>.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetSchemeHandlerConfig::GetSupportedProtocolType']/*"/>
|
|
<msdn-id>ms697058</msdn-id>
|
|
<unmanaged>HRESULT IMFNetSchemeHandlerConfig::GetSupportedProtocolType([In] unsigned int nProtocolIndex,[Out] MFNETSOURCE_PROTOCOL_TYPE* pnProtocolType)</unmanaged>
|
|
<unmanaged-short>IMFNetSchemeHandlerConfig::GetSupportedProtocolType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.NetSchemeHandlerConfig.ResetProtocolRolloverSettings">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Not implemented in this release.</p>
|
|
</summary>
|
|
<returns><p>This method returns <see cref="F:SharpDX.Result.Ok"/>.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetSchemeHandlerConfig::ResetProtocolRolloverSettings']/*"/>
|
|
<msdn-id>ms705604</msdn-id>
|
|
<unmanaged>HRESULT IMFNetSchemeHandlerConfig::ResetProtocolRolloverSettings()</unmanaged>
|
|
<unmanaged-short>IMFNetSchemeHandlerConfig::ResetProtocolRolloverSettings</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.NetSchemeHandlerConfig.NumberOfSupportedProtocols">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of protocols supported by the network scheme plug-in.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFNetSchemeHandlerConfig::GetNumberOfSupportedProtocols']/*"/>
|
|
<msdn-id>ms701625</msdn-id>
|
|
<unmanaged>GetNumberOfSupportedProtocols</unmanaged>
|
|
<unmanaged-short>GetNumberOfSupportedProtocols</unmanaged-short>
|
|
<unmanaged>HRESULT IMFNetSchemeHandlerConfig::GetNumberOfSupportedProtocols([Out] unsigned int* pcProtocols)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ObjectReferenceStream">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Stores the data needed to marshal an interface across a process boundary.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFObjectReferenceStream']/*"/>
|
|
<msdn-id>ms698988</msdn-id>
|
|
<unmanaged>IMFObjectReferenceStream</unmanaged>
|
|
<unmanaged-short>IMFObjectReferenceStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ObjectReferenceStream.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ObjectReferenceStream"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ObjectReferenceStream.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ObjectReferenceStream">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ObjectReferenceStream"/>. (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.MediaFoundation.ObjectReferenceStream.SaveReference(System.Guid,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Stores the data needed to marshal an interface across a process boundary.</p>
|
|
</summary>
|
|
<param name="riid"><dd> <p>Interface identifier of the interface to marshal.</p> </dd></param>
|
|
<param name="unkRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFObjectReferenceStream::SaveReference']/*"/>
|
|
<msdn-id>ms698988</msdn-id>
|
|
<unmanaged>HRESULT IMFObjectReferenceStream::SaveReference([In] const GUID& riid,[In] IUnknown* pUnk)</unmanaged>
|
|
<unmanaged-short>IMFObjectReferenceStream::SaveReference</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ObjectReferenceStream.LoadReference(System.Guid,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Marshals an interface from data stored in the stream.</p>
|
|
</summary>
|
|
<param name="riid"><dd> <p>Interface identifier of the interface to marshal.</p> </dd></param>
|
|
<param name="vOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFObjectReferenceStream::LoadReference']/*"/>
|
|
<msdn-id>ms705636</msdn-id>
|
|
<unmanaged>HRESULT IMFObjectReferenceStream::LoadReference([In] const GUID& riid,[In] void** ppv)</unmanaged>
|
|
<unmanaged-short>IMFObjectReferenceStream::LoadReference</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.OutputPolicy">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Encapsulates a usage policy from an input trust authority (ITA). Output trust authorities (OTAs) use this interface to query which protection systems they are required to enforce by the ITA.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputPolicy']/*"/>
|
|
<msdn-id>ms698985</msdn-id>
|
|
<unmanaged>IMFOutputPolicy</unmanaged>
|
|
<unmanaged-short>IMFOutputPolicy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputPolicy.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.OutputPolicy"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputPolicy.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.OutputPolicy">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.OutputPolicy"/>. (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.MediaFoundation.OutputPolicy.GenerateRequiredSchemas(System.Int32,System.Guid,System.Guid,System.Int32,SharpDX.MediaFoundation.Collection@)">
|
|
<summary>
|
|
<p>Retrieves a list of the output protection systems that the output trust authority (OTA) must enforce, along with configuration data for each protection system. </p> <see cref="T:SharpDX.Result"/> GenerateRequiredSchemas( DWORD dwAttributes, <see cref="T:System.Guid"/> guidOutputSubType, <see cref="T:System.Guid"/>* rgGuidProtectionSchemasSupported, DWORD cProtectionSchemasSupported, <see cref="T:SharpDX.MediaFoundation.Collection"/>** ppRequiredProtectionSchemas
|
|
);<p></p>Parameters <p> dwAttributes </p> <p>[in] Describes the output that is represented by the OTA calling this method. This value is a bitwise OR of zero or more of the following flags.</p> <table><tr> <th> Value </th> <th> Description </th> </tr><tr> <td> <p>MFOUTPUTATTRIBUTE_BUS</p> </td> <td> <p>Hardware bus.</p> </td> </tr><tr> <td> <p>MFOUTPUTATTRIBUTE_COMPRESSED</p> </td> <td> <p>The output sends compressed data. If this flag is absent, the output sends uncompressed data.</p> </td> </tr><tr> <td> <p>MFOUTPUTATTRIBUTE_BUSIMPLEMENTATION</p> </td> <td> <p>Reserved. Do not use.</p> </td> </tr><tr> <td> <p>MFOUTPUTATTRIBUTE_DIGITAL</p> </td> <td> <p>The output sends a digital signal. If this flag is absent, the output sends an analog signal.</p> </td> </tr><tr> <td> <p>MFOUTPUTATTRIBUTE_NONSTANDARDIMPLEMENTATION</p> </td> <td> <p>Reserved. Do not use.</p> </td> </tr><tr> <td> <p>MFOUTPUTATTRIBUTE_SOFTWARE</p> </td> <td> <p>Reserved. Do not use.</p> </td> </tr><tr> <td> <p>MFOUTPUTATTRIBUTE_VIDEO</p> </td> <td> <p>The output sends video data. If this flag is absent, the output sends audio data.</p> </td> </tr></table> <p> guidOutputSubType </p> <p>[in] Indicates a specific family of output connectors that is represented by the OTA calling this method. Possible values include the following.</p> <table><tr> <th> Value </th> <th> Description </th> </tr><tr> <td> <p>MFCONNECTOR_AGP</p> </td> <td> <p>AGP bus.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_COMPONENT</p> </td> <td> <p>Component video.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_COMPOSITE</p> </td> <td> <p>Composite video.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_D_JPN</p> </td> <td> <p>Japanese D connector. (Connector conforming to the EIAJ RC-5237 standard.)</p> </td> </tr><tr> <td> <p>MFCONNECTOR_DISPLAYPORT_EMBEDDED</p> </td> <td> <p>Embedded DisplayPort connector.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_DISPLAYPORT_EXTERNAL</p> </td> <td> <p>External DisplayPort connector.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_DVI</p> </td> <td> <p>Digital video interface (DVI) connector.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_HDMI</p> </td> <td> <p>High-definition multimedia interface (HDMI) connector.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_LVDS</p> </td> <td> <p>Low voltage differential signaling (LVDS) connector.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_PCI</p> </td> <td> <p>PCI bus.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_PCI_Express</p> </td> <td> <p>PCI Express bus.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_PCIX</p> </td> <td> <p>PCI-X bus.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_SPDIF</p> </td> <td> <p>Audio data sent over a connector via S/PDIF.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_SVIDEO</p> </td> <td> <p>S-Video connector.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_UDI_EMBEDDED</p> </td> <td> <p>Embedded Unified Display Interface (UDI).</p> </td> </tr><tr> <td> <p>MFCONNECTOR_UDI_EXTERNAL</p> </td> <td> <p>External UDI.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_UNKNOWN</p> </td> <td> <p>Unknown connector type. You can use this value to initialize variables, but it is not a valid connector type.</p> </td> </tr><tr> <td> <p>MFCONNECTOR_VGA</p> </td> <td> <p>VGA connector.</p> </td> </tr></table> <p> rgGuidProtectionSchemasSupported </p> <p>[in] Pointer to an array of <see cref="T:System.Guid"/> values that specify which output protection systems are supported by the OTA that is calling this method.</p> <p> cProtectionSchemasSupported </p> <p>[in] Number of elements in the rgGuidProtectionSchemasSupported array.</p> <p> ppRequiredProtectionSchemas </p> <p>[out] Receives a reference to the <see cref="T:SharpDX.MediaFoundation.Collection"/> Interface of a collection object. The caller must release the interface. Each object in the collection is an <see cref="T:SharpDX.MediaFoundation.OutputSchema"/> Interface reference. Each <see cref="T:SharpDX.MediaFoundation.OutputSchema"/> interface reference defines an output protection system that the OTA must enforce.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr></table> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFOutputPolicy Interface
|
|
</summary>
|
|
<param name="dwAttributes">No documentation.</param>
|
|
<param name="guidOutputSubType">No documentation.</param>
|
|
<param name="rgGuidProtectionSchemasSupported">No documentation.</param>
|
|
<param name="cProtectionSchemasSupported">No documentation.</param>
|
|
<param name="requiredProtectionSchemasOut">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='IMFOutputPolicy::GenerateRequiredSchemas']/*"/>
|
|
<msdn-id>ms703788</msdn-id>
|
|
<unmanaged>HRESULT IMFOutputPolicy::GenerateRequiredSchemas([In] unsigned int dwAttributes,[In] GUID guidOutputSubType,[In] GUID* rgGuidProtectionSchemasSupported,[In] unsigned int cProtectionSchemasSupported,[Out] IMFCollection** ppRequiredProtectionSchemas)</unmanaged>
|
|
<unmanaged-short>IMFOutputPolicy::GenerateRequiredSchemas</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputPolicy.GetOriginatorID(System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieives a <see cref="T:System.Guid"/> identifying the input trust authority (ITA) that created this output policy object.</p>
|
|
</summary>
|
|
<param name="guidOriginatorIDRef"><dd> <p>Receives a <see cref="T:System.Guid"/> that identifies the originating ITA.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>All of the policy objects and output schemas from the same ITA should return the same originator identifier (including dynamic policy changes). This value enables the OTA to distinguish policies that originate from different ITAs, so that the OTA can update dynamic policies correctly.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputPolicy::GetOriginatorID']/*"/>
|
|
<msdn-id>bb970379</msdn-id>
|
|
<unmanaged>HRESULT IMFOutputPolicy::GetOriginatorID([Out] GUID* pguidOriginatorID)</unmanaged>
|
|
<unmanaged-short>IMFOutputPolicy::GetOriginatorID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputPolicy.GetMinimumGRLVersion(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the minimum version of the global revocation list (GRL) that must be enforced by the protected environment for this policy.</p>
|
|
</summary>
|
|
<param name="dwMinimumGRLVersionRef"><dd> <p>Receives the minimum GRL version.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputPolicy::GetMinimumGRLVersion']/*"/>
|
|
<msdn-id>bb970389</msdn-id>
|
|
<unmanaged>HRESULT IMFOutputPolicy::GetMinimumGRLVersion([Out] unsigned int* pdwMinimumGRLVersion)</unmanaged>
|
|
<unmanaged-short>IMFOutputPolicy::GetMinimumGRLVersion</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.OutputPolicy.OriginatorID">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieives a <see cref="T:System.Guid"/> identifying the input trust authority (ITA) that created this output policy object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>All of the policy objects and output schemas from the same ITA should return the same originator identifier (including dynamic policy changes). This value enables the OTA to distinguish policies that originate from different ITAs, so that the OTA can update dynamic policies correctly.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputPolicy::GetOriginatorID']/*"/>
|
|
<msdn-id>bb970379</msdn-id>
|
|
<unmanaged>GetOriginatorID</unmanaged>
|
|
<unmanaged-short>GetOriginatorID</unmanaged-short>
|
|
<unmanaged>HRESULT IMFOutputPolicy::GetOriginatorID([Out] GUID* pguidOriginatorID)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.OutputPolicy.MinimumGRLVersion">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the minimum version of the global revocation list (GRL) that must be enforced by the protected environment for this policy.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputPolicy::GetMinimumGRLVersion']/*"/>
|
|
<msdn-id>bb970389</msdn-id>
|
|
<unmanaged>GetMinimumGRLVersion</unmanaged>
|
|
<unmanaged-short>GetMinimumGRLVersion</unmanaged-short>
|
|
<unmanaged>HRESULT IMFOutputPolicy::GetMinimumGRLVersion([Out] unsigned int* pdwMinimumGRLVersion)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.OutputSchema">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Encapsulates information about an output protection system and its corresponding configuration data.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the configuration information for the output protection system does not require more than a <strong>DWORD</strong> of space, the configuration information is retrieved in the <strong>GetConfigurationData</strong> method. If more than a <strong>DWORD</strong> of configuration information is needed, it is stored using the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputSchema']/*"/>
|
|
<msdn-id>ms703800</msdn-id>
|
|
<unmanaged>IMFOutputSchema</unmanaged>
|
|
<unmanaged-short>IMFOutputSchema</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputSchema.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.OutputSchema"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputSchema.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.OutputSchema">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.OutputSchema"/>. (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.MediaFoundation.OutputSchema.GetSchemaType(System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the output protection system that is represented by this object. Output protection systems are identified by <see cref="T:System.Guid"/> value.</p>
|
|
</summary>
|
|
<param name="guidSchemaTypeRef"><dd> <p>Receives the <see cref="T:System.Guid"/> that identifies the output protection system.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputSchema::GetSchemaType']/*"/>
|
|
<msdn-id>bb970414</msdn-id>
|
|
<unmanaged>HRESULT IMFOutputSchema::GetSchemaType([Out] GUID* pguidSchemaType)</unmanaged>
|
|
<unmanaged-short>IMFOutputSchema::GetSchemaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputSchema.GetConfigurationData(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Returns configuration data for the output protection system. The configuration data is used to enable or disable the protection system, and to set the protection levels.</p>
|
|
</summary>
|
|
<param name="dwValRef"><dd> <p>Receives the configuration data. The meaning of this data depends on the output protection system.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputSchema::GetConfigurationData']/*"/>
|
|
<msdn-id>bb970364</msdn-id>
|
|
<unmanaged>HRESULT IMFOutputSchema::GetConfigurationData([Out] unsigned int* pdwVal)</unmanaged>
|
|
<unmanaged-short>IMFOutputSchema::GetConfigurationData</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputSchema.GetOriginatorID(System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a <see cref="T:System.Guid"/> identifying the input trust authority (ITA) that generated this output schema object.</p>
|
|
</summary>
|
|
<param name="guidOriginatorIDRef"><dd> <p>Receives a <see cref="T:System.Guid"/> that identifies the originating ITA.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>All of the policy objects and output schemas from the same ITA should return the same originator identifier (including dynamic policy changes). This value enables the OTA to distinguish policies that originate from different ITAs, so that the OTA can update dynamic policies correctly.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputSchema::GetOriginatorID']/*"/>
|
|
<msdn-id>bb970483</msdn-id>
|
|
<unmanaged>HRESULT IMFOutputSchema::GetOriginatorID([Out] GUID* pguidOriginatorID)</unmanaged>
|
|
<unmanaged-short>IMFOutputSchema::GetOriginatorID</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.OutputSchema.SchemaType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the output protection system that is represented by this object. Output protection systems are identified by <see cref="T:System.Guid"/> value.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputSchema::GetSchemaType']/*"/>
|
|
<msdn-id>bb970414</msdn-id>
|
|
<unmanaged>GetSchemaType</unmanaged>
|
|
<unmanaged-short>GetSchemaType</unmanaged-short>
|
|
<unmanaged>HRESULT IMFOutputSchema::GetSchemaType([Out] GUID* pguidSchemaType)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.OutputSchema.ConfigurationData">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Returns configuration data for the output protection system. The configuration data is used to enable or disable the protection system, and to set the protection levels.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputSchema::GetConfigurationData']/*"/>
|
|
<msdn-id>bb970364</msdn-id>
|
|
<unmanaged>GetConfigurationData</unmanaged>
|
|
<unmanaged-short>GetConfigurationData</unmanaged-short>
|
|
<unmanaged>HRESULT IMFOutputSchema::GetConfigurationData([Out] unsigned int* pdwVal)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.OutputSchema.OriginatorID">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a <see cref="T:System.Guid"/> identifying the input trust authority (ITA) that generated this output schema object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>All of the policy objects and output schemas from the same ITA should return the same originator identifier (including dynamic policy changes). This value enables the OTA to distinguish policies that originate from different ITAs, so that the OTA can update dynamic policies correctly.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputSchema::GetOriginatorID']/*"/>
|
|
<msdn-id>bb970483</msdn-id>
|
|
<unmanaged>GetOriginatorID</unmanaged>
|
|
<unmanaged-short>GetOriginatorID</unmanaged-short>
|
|
<unmanaged>HRESULT IMFOutputSchema::GetOriginatorID([Out] GUID* pguidOriginatorID)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.OutputTrustAuthority">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Encapsulates the functionality of one or more output protection systems that a trusted output supports. This interface is exposed by output trust authority (OTA) objects. Each OTA represents a single action that the trusted output can perform, such as play, copy, or transcode. An OTA can represent more than one physical output if each output performs the same action.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputTrustAuthority']/*"/>
|
|
<msdn-id>ms695254</msdn-id>
|
|
<unmanaged>IMFOutputTrustAuthority</unmanaged>
|
|
<unmanaged-short>IMFOutputTrustAuthority</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputTrustAuthority.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.OutputTrustAuthority"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputTrustAuthority.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.OutputTrustAuthority">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.OutputTrustAuthority"/>. (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.MediaFoundation.OutputTrustAuthority.GetAction(SharpDX.MediaFoundation.PolicymanagerAction@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the action that is performed by this output trust authority (OTA).</p>
|
|
</summary>
|
|
<param name="actionRef"><dd> <p>Receives a member of the <see cref="T:SharpDX.MediaFoundation.PolicymanagerAction"/> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputTrustAuthority::GetAction']/*"/>
|
|
<msdn-id>bb970410</msdn-id>
|
|
<unmanaged>HRESULT IMFOutputTrustAuthority::GetAction([Out] MFPOLICYMANAGER_ACTION* pAction)</unmanaged>
|
|
<unmanaged-short>IMFOutputTrustAuthority::GetAction</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputTrustAuthority.SetPolicy(SharpDX.MediaFoundation.OutputPolicy[],System.Int32,System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sets one or more policy objects on the output trust authority (OTA). </p>
|
|
</summary>
|
|
<param name="policyOut"><dd> <p>The address of an array of <strong><see cref="T:SharpDX.MediaFoundation.OutputPolicy"/></strong> references. </p> </dd></param>
|
|
<param name="nPolicy"><dd> <p> The number of elements in the <em>ppPolicy</em> array. </p> </dd></param>
|
|
<param name="bTicketOut"><dd> <p> Receives either a reference to a buffer allocated by the OTA, or the value <strong><c>null</c></strong>. If this parameter receives a non-<strong><c>null</c></strong> value, the caller must release the buffer by calling <strong>CoTaskMemFree</strong>. </p> <p><strong>Note</strong>??Currently this parameter is reserved. An OTA should set the reference to <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="cbTicketRef"><dd> <p> Receives the size of the <em>ppbTicket</em> buffer, in bytes. If <em>ppbTicket</em> receives the value <strong><c>null</c></strong>, <em>pcbTicket</em> receives the value zero.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_S_WAIT_FOR_POLICY_SET</strong></dt> </dl> </td><td> <p> The policy was negotiated successfully, but the OTA will enforce it asynchronously. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_POLICY_UNSUPPORTED</strong></dt> </dl> </td><td> <p> The OTA does not support the requirements of this policy. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the method returns <strong>MF_S_WAIT_FOR_POLICY_SET</strong>, the OTA sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.PolicySet"/> event when it enforces the policy.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputTrustAuthority::SetPolicy']/*"/>
|
|
<msdn-id>bb970572</msdn-id>
|
|
<unmanaged>HRESULT IMFOutputTrustAuthority::SetPolicy([In, Buffer, Optional] IMFOutputPolicy** ppPolicy,[In] unsigned int nPolicy,[Out, Buffer, Optional] unsigned char** ppbTicket,[Out, Optional] unsigned int* pcbTicket)</unmanaged>
|
|
<unmanaged-short>IMFOutputTrustAuthority::SetPolicy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.OutputTrustAuthority.SetPolicy(SharpDX.ComArray{SharpDX.MediaFoundation.OutputPolicy},System.Int32,System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sets one or more policy objects on the output trust authority (OTA). </p>
|
|
</summary>
|
|
<param name="policyOut"><dd> <p>The address of an array of <strong><see cref="T:SharpDX.MediaFoundation.OutputPolicy"/></strong> references. </p> </dd></param>
|
|
<param name="nPolicy"><dd> <p> The number of elements in the <em>ppPolicy</em> array. </p> </dd></param>
|
|
<param name="bTicketOut"><dd> <p> Receives either a reference to a buffer allocated by the OTA, or the value <strong><c>null</c></strong>. If this parameter receives a non-<strong><c>null</c></strong> value, the caller must release the buffer by calling <strong>CoTaskMemFree</strong>. </p> <p><strong>Note</strong>??Currently this parameter is reserved. An OTA should set the reference to <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="cbTicketRef"><dd> <p> Receives the size of the <em>ppbTicket</em> buffer, in bytes. If <em>ppbTicket</em> receives the value <strong><c>null</c></strong>, <em>pcbTicket</em> receives the value zero.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_S_WAIT_FOR_POLICY_SET</strong></dt> </dl> </td><td> <p> The policy was negotiated successfully, but the OTA will enforce it asynchronously. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_POLICY_UNSUPPORTED</strong></dt> </dl> </td><td> <p> The OTA does not support the requirements of this policy. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the method returns <strong>MF_S_WAIT_FOR_POLICY_SET</strong>, the OTA sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.PolicySet"/> event when it enforces the policy.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputTrustAuthority::SetPolicy']/*"/>
|
|
<msdn-id>bb970572</msdn-id>
|
|
<unmanaged>HRESULT IMFOutputTrustAuthority::SetPolicy([In, Buffer, Optional] IMFOutputPolicy** ppPolicy,[In] unsigned int nPolicy,[Out, Buffer, Optional] unsigned char** ppbTicket,[Out, Optional] unsigned int* pcbTicket)</unmanaged>
|
|
<unmanaged-short>IMFOutputTrustAuthority::SetPolicy</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.OutputTrustAuthority.Action">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the action that is performed by this output trust authority (OTA).</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFOutputTrustAuthority::GetAction']/*"/>
|
|
<msdn-id>bb970410</msdn-id>
|
|
<unmanaged>GetAction</unmanaged>
|
|
<unmanaged-short>GetAction</unmanaged-short>
|
|
<unmanaged>HRESULT IMFOutputTrustAuthority::GetAction([Out] MFPOLICYMANAGER_ACTION* pAction)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PluginControl">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how media sources and transforms are enumerated in Microsoft Media Foundation.</p><p>To get a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.GetPluginControl(SharpDX.MediaFoundation.PluginControl@)"/></strong>.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Media Foundation provides a set of built-in media sources and decoders. Applications can enumerate them as follows: </p><ul> <li>Media sources are enumerated through the Source Resolver.</li> <li>Transforms, such as decoders, are enumerated through the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnum(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.MediaAttributes,System.Guid[],System.Int32@)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> functions.</li> </ul><p>Applications might also enumerate these objects indirectly. For example, if an application uses the topology loader to resolve a partial topology, the topology loader calls <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TEnumEx(System.Guid,System.Int32,System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},System.Nullable{SharpDX.MediaFoundation.TRegisterTypeInformation},SharpDX.MediaFoundation.Activate[],System.Int32@)"/></strong> to find the required decoders.</p><p>Third parties can implement their own custom media sources and decoders, and register them for enumeration so that other applications can use them.</p><p>To control the enumeration order, Media Foundation maintains two process-wide lists of CLSIDs: a preferred list and a blocked list. An object whose CLSID appears in the preferred list appears first in the enumeration order. An object whose CLSID appears on the blocked list is not enumerated.</p><p>The lists are initially populated from the registry. Applications can use the <strong><see cref="T:SharpDX.MediaFoundation.PluginControl"/></strong> interface to modify the lists for the current process.</p><p>The preferred list contains a set of key/value pairs, where the keys are strings and the values are CLSIDs. These key/value pairs are defined as follows:</p><ul> <li>For media sources, the key name is a file name extension, protocol scheme, or MIME type. The value is the CLSID of a scheme handler or byte-stream handler for that media source.</li> <li>For decoders, the key name is a media subtype <see cref="T:System.Guid"/> in canonical string form. (For more information about media subtypes, see Media Types.) The value is the CLSID of the Media Foundation transform (MFT) that implements the decoder. </li> </ul><p>The following examples show the various types of key:</p><ul> <li>File extension: ".wmv"</li> <li>Scheme: "http:"</li> <li>MIME type: "video/mp4"</li> <li>Media subtype: "{47504A4D-0000-0010-8000-00AA00389B71}"</li> </ul><p>To search the preferred list by key name, call the <strong><see cref="M:SharpDX.MediaFoundation.PluginControl.GetPreferredClsid(System.Int32,System.String,System.Guid@)"/></strong> method. To enumerate the entire list, call the <strong><see cref="M:SharpDX.MediaFoundation.PluginControl.GetPreferredClsidByIndex(System.Int32,System.Int32,System.IntPtr,System.Guid@)"/></strong> method in a loop.</p><p>The blocked list contains a list of CLSIDs. To enumerate the entire list, call the <strong><see cref="M:SharpDX.MediaFoundation.PluginControl.GetDisabledByIndex(System.Int32,System.Int32,System.Guid@)"/></strong> method in a loop. To check whether a specific CLSID appears on the list, call the <strong><see cref="M:SharpDX.MediaFoundation.PluginControl.IsDisabled(System.Int32,System.Guid)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPluginControl']/*"/>
|
|
<msdn-id>dd374302</msdn-id>
|
|
<unmanaged>IMFPluginControl</unmanaged>
|
|
<unmanaged-short>IMFPluginControl</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PluginControl.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PluginControl"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PluginControl.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PluginControl">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PluginControl"/>. (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.MediaFoundation.PluginControl.GetPreferredClsid(System.Int32,System.String,System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Searches the preferred list for a class identifier (CLSID) that matches a specified key name.</p>
|
|
</summary>
|
|
<param name="pluginType"><dd> <p>Member of the <strong><see cref="T:SharpDX.MediaFoundation.PluginType"/></strong> enumeration, specifying the type of object.</p> </dd></param>
|
|
<param name="selector"><dd> <p>The key name to match. For more information about the format of key names, see the Remarks section of <strong><see cref="T:SharpDX.MediaFoundation.PluginControl"/></strong>.</p> </dd></param>
|
|
<param name="clsid"><dd> <p>Receives a CLSID from the preferred list.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>HRESULT_FROM_WIN32(<see cref="F:SharpDX.Win32.ErrorCode.NotFound"/>)</strong></strong></dt> </dl> </td><td> <p>No CLSID matching this key was found.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPluginControl::GetPreferredClsid']/*"/>
|
|
<msdn-id>dd374304</msdn-id>
|
|
<unmanaged>HRESULT IMFPluginControl::GetPreferredClsid([In] unsigned int pluginType,[In] const wchar_t* selector,[Out] GUID* clsid)</unmanaged>
|
|
<unmanaged-short>IMFPluginControl::GetPreferredClsid</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PluginControl.GetPreferredClsidByIndex(System.Int32,System.Int32,System.IntPtr,System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets a class identifier (CLSID) from the preferred list, specified by index value.</p>
|
|
</summary>
|
|
<param name="pluginType"><dd> <p>Member of the <strong><see cref="T:SharpDX.MediaFoundation.PluginType"/></strong> enumeration, specifying the type of object to enumerate.</p> </dd></param>
|
|
<param name="index"><dd> <p>The zero-based index of the CLSID to retrieve.</p> </dd></param>
|
|
<param name="selector"><dd> <p>Receives the key name associated with the CLSID. The caller must free the memory for the returned string by calling the <strong>CoTaskMemFree</strong> function. For more information about the format of key names, see the Remarks section of <strong><see cref="T:SharpDX.MediaFoundation.PluginControl"/></strong>.</p> </dd></param>
|
|
<param name="clsid"><dd> <p>Receives the CLSID at the specified index.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>HRESULT_FROM_WIN32(<see cref="F:SharpDX.Win32.ErrorCode.NoMoreItems"/>)</strong></strong></dt> </dl> </td><td> <p>The <em>index</em> parameter is out of range.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPluginControl::GetPreferredClsidByIndex']/*"/>
|
|
<msdn-id>dd374305</msdn-id>
|
|
<unmanaged>HRESULT IMFPluginControl::GetPreferredClsidByIndex([In] unsigned int pluginType,[In] unsigned int index,[Out] wchar_t** selector,[Out] GUID* clsid)</unmanaged>
|
|
<unmanaged-short>IMFPluginControl::GetPreferredClsidByIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PluginControl.SetPreferredClsid(System.Int32,System.String,System.Nullable{System.Guid})">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Adds a class identifier (CLSID) to the preferred list or removes a CLSID from the list.</p>
|
|
</summary>
|
|
<param name="pluginType"><dd> <p>Member of the <strong><see cref="T:SharpDX.MediaFoundation.PluginType"/></strong> enumeration, specifying the type of object.</p> </dd></param>
|
|
<param name="selector"><dd> <p>The key name for the CLSID. For more information about the format of key names, see the Remarks section of <strong><see cref="T:SharpDX.MediaFoundation.PluginControl"/></strong>.</p> </dd></param>
|
|
<param name="clsid"><dd> <p>The CLSID to add to the list. If this parameter is <strong><c>null</c></strong>, the key/value entry specified by the <em>selector</em> parameter is removed from the list. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The preferred list is global to the caller's process. Calling this method does not affect the list in other process.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPluginControl::SetPreferredClsid']/*"/>
|
|
<msdn-id>dd374308</msdn-id>
|
|
<unmanaged>HRESULT IMFPluginControl::SetPreferredClsid([In] unsigned int pluginType,[In] const wchar_t* selector,[In, Optional] const GUID* clsid)</unmanaged>
|
|
<unmanaged-short>IMFPluginControl::SetPreferredClsid</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PluginControl.IsDisabled(System.Int32,System.Guid)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Queries whether a class identifier (CLSID) appears in the blocked list.</p>
|
|
</summary>
|
|
<param name="pluginType"><dd> <p>Member of the <strong><see cref="T:SharpDX.MediaFoundation.PluginType"/></strong> enumeration, specifying the type of object for the query.</p> </dd></param>
|
|
<param name="clsid"><dd> <p>The CLSID to search for.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The specified CLSID appears in the blocked list.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>HRESULT_FROM_WIN32(<see cref="F:SharpDX.Win32.ErrorCode.NotFound"/>)</strong></strong></dt> </dl> </td><td> <p>The specified CLSID is not in the blocked list.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPluginControl::IsDisabled']/*"/>
|
|
<msdn-id>dd374306</msdn-id>
|
|
<unmanaged>HRESULT IMFPluginControl::IsDisabled([In] unsigned int pluginType,[In] const GUID& clsid)</unmanaged>
|
|
<unmanaged-short>IMFPluginControl::IsDisabled</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PluginControl.GetDisabledByIndex(System.Int32,System.Int32,System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets a class identifier (CLSID) from the blocked list.</p>
|
|
</summary>
|
|
<param name="pluginType"><dd> <p>Member of the <strong><see cref="T:SharpDX.MediaFoundation.PluginType"/></strong> enumeration, specifying the type of object to enumerate.</p> </dd></param>
|
|
<param name="index"><dd> <p>The zero-based index of the CLSID to retrieve.</p> </dd></param>
|
|
<param name="clsid"><dd> <p>Receives the CLSID at the specified index.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>HRESULT_FROM_WIN32(<see cref="F:SharpDX.Win32.ErrorCode.NoMoreItems"/>)</strong></strong></dt> </dl> </td><td> <p>The <em>index</em> parameter is out of range.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPluginControl::GetDisabledByIndex']/*"/>
|
|
<msdn-id>dd374303</msdn-id>
|
|
<unmanaged>HRESULT IMFPluginControl::GetDisabledByIndex([In] unsigned int pluginType,[In] unsigned int index,[Out] GUID* clsid)</unmanaged>
|
|
<unmanaged-short>IMFPluginControl::GetDisabledByIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PluginControl.SetDisabled(System.Int32,System.Guid,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Adds a class identifier (CLSID) to the blocked list, or removes a CLSID from the list.</p>
|
|
</summary>
|
|
<param name="pluginType"><dd> <p>Member of the <strong><see cref="T:SharpDX.MediaFoundation.PluginType"/></strong> enumeration, specifying the type of object.</p> </dd></param>
|
|
<param name="clsid"><dd> <p>The CLSID to add or remove.</p> </dd></param>
|
|
<param name="disabled"><dd> <p>Specifies whether to add or remove the CSLID. If the value is <strong>TRUE</strong>, the method adds the CLSID to the blocked list. Otherwise, the method removes it from the list.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> The blocked list is global to the caller's process. Calling this method does not affect the list in other processes. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPluginControl::SetDisabled']/*"/>
|
|
<msdn-id>dd374307</msdn-id>
|
|
<unmanaged>HRESULT IMFPluginControl::SetDisabled([In] unsigned int pluginType,[In] const GUID& clsid,[In] BOOL disabled)</unmanaged>
|
|
<unmanaged-short>IMFPluginControl::SetDisabled</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PluginControl2">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Controls how media sources and transforms are enumerated in Microsoft Media Foundation.</p><p>This interface extends the <strong><see cref="T:SharpDX.MediaFoundation.PluginControl"/></strong> interface.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To get a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.GetPluginControl(SharpDX.MediaFoundation.PluginControl@)"/></strong> and query the returned reference for <strong><see cref="T:SharpDX.MediaFoundation.PluginControl2"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPluginControl2']/*"/>
|
|
<msdn-id>hh448043</msdn-id>
|
|
<unmanaged>IMFPluginControl2</unmanaged>
|
|
<unmanaged-short>IMFPluginControl2</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PluginControl2.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PluginControl2"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PluginControl2.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PluginControl2">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PluginControl2"/>. (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.MediaFoundation.PluginControl2.SetPolicy(SharpDX.MediaFoundation.PluginControlPolicy)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Sets the policy for which media sources and transforms are enumerated.</p>
|
|
</summary>
|
|
<param name="policy"><dd> <p>A value from the <strong><see cref="T:SharpDX.MediaFoundation.PluginControlPolicy"/></strong> enumeration that specifies the policy.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPluginControl2::SetPolicy']/*"/>
|
|
<msdn-id>hh448044</msdn-id>
|
|
<unmanaged>HRESULT IMFPluginControl2::SetPolicy([In] MF_PLUGIN_CONTROL_POLICY policy)</unmanaged>
|
|
<unmanaged-short>IMFPluginControl2::SetPolicy</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PluginControl2.Policy">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Sets the policy for which media sources and transforms are enumerated.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPluginControl2::SetPolicy']/*"/>
|
|
<msdn-id>hh448044</msdn-id>
|
|
<unmanaged>SetPolicy</unmanaged>
|
|
<unmanaged-short>SetPolicy</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPluginControl2::SetPolicy([In] MF_PLUGIN_CONTROL_POLICY policy)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMediaItem">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Note</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p> Represents a media item. A <em>media item</em> is an abstraction for a source of media data, such as a video file. Use this interface to get information about the source, or to change certain playback settings, such as the start and stop times. To get a reference to this interface, call one of the following methods:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromObject(SharpDX.ComObject,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromURL(System.String,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> </li> </ul>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem']/*"/>
|
|
<msdn-id>dd374309</msdn-id>
|
|
<unmanaged>IMFPMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PMediaItem"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PMediaItem">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PMediaItem"/>. (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.MediaFoundation.PMediaItem.GetMediaPlayer(SharpDX.MediaFoundation.PMediaPlayer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets a reference to the MFPlay player object that created the media item.</p>
|
|
</summary>
|
|
<param name="mediaPlayerOut">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetMediaPlayer']/*"/>
|
|
<msdn-id>dd374313</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetMediaPlayer([Out] IMFPMediaPlayer** ppMediaPlayer)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetMediaPlayer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetURL(System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the URL that was used to create the media item.</p>
|
|
</summary>
|
|
<param name="wszURLOut">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOTFOUND</strong></dt> </dl> </td><td> <p>No URL is associated with this media item.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.Shutdown"/></strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method applies when the application calls <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromURL(System.String,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> to create a media item. If the application calls <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromObject(SharpDX.ComObject,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> to create a media item, the <strong>GetURL</strong> method for that media item returns <strong>MF_E_NOTFOUND</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetURL']/*"/>
|
|
<msdn-id>dd374320</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetURL([Out] wchar_t** ppwszURL)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetURL</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetObjectW(SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the object that was used to create the media item.</p>
|
|
</summary>
|
|
<param name="iUnknownOut">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOTFOUND</strong></dt> </dl> </td><td> <p>The media item was created from a URL, not from an object.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.Shutdown"/></strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The object reference is set if the application uses <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromObject(SharpDX.ComObject,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> to create the media item. Otherwise, <strong>GetObject</strong> returns MF_E_NOTFOUND.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetObjectW']/*"/>
|
|
<msdn-id>dd374315</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetObjectW([Out] IUnknown** ppIUnknown)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetObjectW</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetUserData(System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the application-defined value stored in the media item.</p>
|
|
</summary>
|
|
<param name="dwUserDataRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>You can assign this value when you first create the media item, by specifying it in the <em>dwUserData</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromURL(System.String,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromObject(SharpDX.ComObject,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> method. To update the value, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.SetUserData(System.IntPtr)"/></strong>.</p><p>This method can be called after the player object is shut down.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetUserData']/*"/>
|
|
<msdn-id>dd374321</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetUserData([Out] ULONG_PTR* pdwUserData)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetUserData</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.SetUserData(System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Stores an application-defined value in the media item.</p>
|
|
</summary>
|
|
<param name="dwUserData">No documentation.</param>
|
|
<returns><p>This method can return one of these values.</p></returns>
|
|
<remarks>
|
|
<p>This method can be called after the player object is shut down.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::SetUserData']/*"/>
|
|
<msdn-id>dd374328</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::SetUserData([In] ULONG_PTR dwUserData)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::SetUserData</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetStartStopPosition(System.Guid@,SharpDX.Win32.Variant@,System.Guid@,SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the start and stop times for the media item.</p>
|
|
</summary>
|
|
<param name="guidStartPositionTypeRef">No documentation.</param>
|
|
<param name="vStartValueRef">No documentation.</param>
|
|
<param name="guidStopPositionTypeRef">No documentation.</param>
|
|
<param name="vStopValueRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The <em>pguidStartPositionType</em> and <em>pguidStopPositionType</em> parameters receive the units of time that are used. Currently, the only supported value is <strong>MFP_POSITIONTYPE_100NS</strong>.</p><table> <tr><th>Value</th><th>Description</th></tr> <tr><td>MFP_POSITIONTYPE_100NS</td><td>100-nanosecond units. The time parameter (<em>pvStartValue</em> or <em>pvStopValue</em>) uses the following data type:<ul> <li>Variant type (<strong>vt</strong>): VT_I8</li> <li>Variant member: <strong>hVal</strong></li> </ul> </td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetStartStopPosition']/*"/>
|
|
<msdn-id>dd374317</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetStartStopPosition([Out, Optional] GUID* pguidStartPositionType,[Out, Optional] PROPVARIANT* pvStartValue,[Out, Optional] GUID* pguidStopPositionType,[Out, Optional] PROPVARIANT* pvStopValue)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetStartStopPosition</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.SetStartStopPosition(System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant},System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Sets the start and stop time for the media item.</p>
|
|
</summary>
|
|
<param name="guidStartPositionTypeRef">No documentation.</param>
|
|
<param name="vStartValueRef">No documentation.</param>
|
|
<param name="guidStopPositionTypeRef">No documentation.</param>
|
|
<param name="vStopValueRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_OUT_OF_RANGE</strong></dt> </dl> </td><td> <p>Invalid start or stop time. Any of the following can cause this error:</p> <ul> <li>Time less than zero.</li> <li>Time greater than the total duration of the media item.</li> <li>Stop time less than start time.</li> </ul> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>By default, a media item plays from the beginning to the end of the file. This method adjusts the start time and/or the stop time:</p><ul> <li>To set the start time, pass non-<strong><c>null</c></strong> values for <em>pguidStartPositionType</em> and <em>pvStartValue</em>.</li> <li>To set the stop time, pass non-<strong><c>null</c></strong> values for <em>pguidStopPositionType</em> and <em>pvStopValue</em>.</li> </ul><p>The <em>pguidStartPositionType</em> and <em>pguidStopPositionType</em> parameters give the units of time that are used. Currently, the only supported value is <strong>MFP_POSITIONTYPE_100NS</strong>.</p><table> <tr><th>Value</th><th>Description</th></tr> <tr><td><strong>MFP_POSITIONTYPE_100NS</strong></td><td>100-nanosecond units. The time parameter (<em>pvStartValue</em> or <em>pvStopValue</em>) uses the following data type:<ul> <li>Variant type (<strong>vt</strong>): <strong>VT_I8</strong></li> <li>Variant member: <strong>hVal</strong></li> </ul> <p>To clear a previously set time, use an empty <strong><see cref="T:SharpDX.Win32.Variant"/></strong> (<strong>VT_EMPTY</strong>).</p> </td></tr> </table><p>?</p><p>The adjusted start and stop times are used the next time that <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.SetMediaItem(SharpDX.MediaFoundation.PMediaItem)"/></strong> is called with this media item. If the media item is already set on the player, the change does not happen unless you call <strong>SetMediaItem</strong> again.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::SetStartStopPosition']/*"/>
|
|
<msdn-id>dd374325</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::SetStartStopPosition([In, Optional] const GUID* pguidStartPositionType,[In, Optional] const PROPVARIANT* pvStartValue,[In, Optional] const GUID* pguidStopPositionType,[In, Optional] const PROPVARIANT* pvStopValue)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::SetStartStopPosition</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.HasVideo(System.Boolean@,System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Queries whether the media item contains a video stream.</p>
|
|
</summary>
|
|
<param name="fHasVideoRef">No documentation.</param>
|
|
<param name="fSelectedRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> To select or deselect streams before playback starts, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.SetStreamSelection(System.Int32,System.Boolean)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::HasVideo']/*"/>
|
|
<msdn-id>dd374323</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::HasVideo([Out, Optional] BOOL* pfHasVideo,[Out, Optional] BOOL* pfSelected)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::HasVideo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.HasAudio(System.Boolean@,System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Queries whether the media item contains an audio stream.</p>
|
|
</summary>
|
|
<param name="fHasAudioRef">No documentation.</param>
|
|
<param name="fSelectedRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> To select or deselect streams before playback starts, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.SetStreamSelection(System.Int32,System.Boolean)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::HasAudio']/*"/>
|
|
<msdn-id>dd374322</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::HasAudio([Out, Optional] BOOL* pfHasAudio,[Out, Optional] BOOL* pfSelected)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::HasAudio</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.IsProtected_(System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Queries whether the media item contains protected content.</p><p><strong>Note</strong>??Currently <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/></strong> does not support playing protected content.</p>
|
|
</summary>
|
|
<param name="fProtectedRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::IsProtected']/*"/>
|
|
<msdn-id>dd374324</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::IsProtected([Out] BOOL* pfProtected)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::IsProtected</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetDuration(System.Guid,SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the duration of the media item.</p>
|
|
</summary>
|
|
<param name="guidPositionType">No documentation.</param>
|
|
<param name="vDurationValueRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The method returns the total duration of the content, regardless of any values set through <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.SetStartStopPosition(System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant},System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetDuration']/*"/>
|
|
<msdn-id>dd374312</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetDuration([In] const GUID& guidPositionType,[Out] PROPVARIANT* pvDurationValue)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetDuration</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetNumberOfStreams(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the number of streams (audio, video, and other) in the media item.</p>
|
|
</summary>
|
|
<param name="dwStreamCountRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetNumberOfStreams']/*"/>
|
|
<msdn-id>dd374314</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetNumberOfStreams([Out] unsigned int* pdwStreamCount)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetNumberOfStreams</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetStreamSelection(System.Int32,System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Queries whether a stream is selected to play.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex">No documentation.</param>
|
|
<param name="fEnabledRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> To select or deselect a stream, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.SetStreamSelection(System.Int32,System.Boolean)"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetStreamSelection']/*"/>
|
|
<msdn-id>dd374319</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetStreamSelection([In] unsigned int dwStreamIndex,[Out] BOOL* pfEnabled)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetStreamSelection</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.SetStreamSelection(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Selects or deselects a stream.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex">No documentation.</param>
|
|
<param name="fEnabled">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>You can use this method to change which streams are selected. The change goes into effect the next time that <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.SetMediaItem(SharpDX.MediaFoundation.PMediaItem)"/></strong> is called with this media item. If the media item is already set on the player, the change does not happen unless you call <strong>SetMediaItem</strong> again with this media item.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::SetStreamSelection']/*"/>
|
|
<msdn-id>dd374326</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::SetStreamSelection([In] unsigned int dwStreamIndex,[In] BOOL fEnabled)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::SetStreamSelection</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetStreamAttribute(System.Int32,System.Guid,SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Queries the media item for a stream attribute.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex">No documentation.</param>
|
|
<param name="guidMFAttribute">No documentation.</param>
|
|
<param name="vValueRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Stream attributes describe an individual stream (audio, video, or other) within the presentation. To get an attribute that applies to the entire presentation, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.GetPresentationAttribute(System.Guid,SharpDX.Win32.Variant@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetStreamAttribute']/*"/>
|
|
<msdn-id>dd374318</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetStreamAttribute([In] unsigned int dwStreamIndex,[In] const GUID& guidMFAttribute,[Out] PROPVARIANT* pvValue)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetStreamAttribute</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetPresentationAttribute(System.Guid,SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Queries the media item for a presentation attribute.</p>
|
|
</summary>
|
|
<param name="guidMFAttribute">No documentation.</param>
|
|
<param name="vValueRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Presentation attributes describe the presentation as a whole. To get an attribute that applies to an individual stream within the presentation, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.GetStreamAttribute(System.Int32,System.Guid,SharpDX.Win32.Variant@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetPresentationAttribute']/*"/>
|
|
<msdn-id>dd374316</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetPresentationAttribute([In] const GUID& guidMFAttribute,[Out] PROPVARIANT* pvValue)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetPresentationAttribute</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetCharacteristics(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets various flags that describe the media item.</p>
|
|
</summary>
|
|
<param name="characteristicsRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetCharacteristics']/*"/>
|
|
<msdn-id>dd374311</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetCharacteristics([Out] unsigned int* pCharacteristics)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetCharacteristics</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.SetStreamSink(System.Int32,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p> Sets a media sink for the media item. A <em>media sink</em> is an object that consumes the data from one or more streams. </p>
|
|
</summary>
|
|
<param name="dwStreamIndex">No documentation.</param>
|
|
<param name="mediaSinkRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>By default, the MFPlay player object renders audio streams to the Streaming Audio Renderer (SAR) and video streams to the Enhanced Video Renderer (EVR). You can use the <strong>SetStreamSink</strong> method to provide a different media sink for an audio or video stream; or to support other stream types besides audio and video. You can also use it to configure the SAR or EVR before they are used.</p><p>Call this method before calling <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.SetMediaItem(SharpDX.MediaFoundation.PMediaItem)"/></strong>. Calling this method after <strong>SetMediaItem</strong> has no effect, unless you stop playback and call <strong>SetMediaItem</strong> again.</p><p>To reset the media item to use the default media sink, set <em>pMediaSink</em> to <strong><c>null</c></strong>.</p>Remote Playback Optimizations<p>If the application is running over Remote Desktop, and you call this method with a non-<c>null</c> value for an audio or video stream, MFPlay disables remote playback optimizations. This remark applies only to audio and video streams. It does not apply to streams that contain some other data type, such as text.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::SetStreamSink']/*"/>
|
|
<msdn-id>dd374327</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::SetStreamSink([In] unsigned int dwStreamIndex,[In, Optional] IUnknown* pMediaSink)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::SetStreamSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaItem.GetMetadata(SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets a property store that contains metadata for the source, such as author or title.</p>
|
|
</summary>
|
|
<param name="metadataStoreOut">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetMetadata']/*"/>
|
|
<msdn-id>dd798056</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetMetadata([Out] IPropertyStore** ppMetadataStore)</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem::GetMetadata</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaItem.MediaPlayer">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets a reference to the MFPlay player object that created the media item.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetMediaPlayer']/*"/>
|
|
<msdn-id>dd374313</msdn-id>
|
|
<unmanaged>GetMediaPlayer</unmanaged>
|
|
<unmanaged-short>GetMediaPlayer</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetMediaPlayer([Out] IMFPMediaPlayer** ppMediaPlayer)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaItem.ObjectW">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the object that was used to create the media item.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The object reference is set if the application uses <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromObject(SharpDX.ComObject,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> to create the media item. Otherwise, <strong>GetObject</strong> returns MF_E_NOTFOUND.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetObjectW']/*"/>
|
|
<msdn-id>dd374315</msdn-id>
|
|
<unmanaged>GetObjectW</unmanaged>
|
|
<unmanaged-short>GetObjectW</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetObjectW([Out] IUnknown** ppIUnknown)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaItem.UserData">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the application-defined value stored in the media item.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>You can assign this value when you first create the media item, by specifying it in the <em>dwUserData</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromURL(System.String,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromObject(SharpDX.ComObject,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> method. To update the value, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.SetUserData(System.IntPtr)"/></strong>.</p><p>This method can be called after the player object is shut down.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetUserData']/*"/>
|
|
<msdn-id>dd374321</msdn-id>
|
|
<unmanaged>GetUserData</unmanaged>
|
|
<unmanaged-short>GetUserData</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetUserData([Out] ULONG_PTR* pdwUserData)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaItem.IsProtected">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Queries whether the media item contains protected content.</p><p><strong>Note</strong>??Currently <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/></strong> does not support playing protected content.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::IsProtected']/*"/>
|
|
<msdn-id>dd374324</msdn-id>
|
|
<unmanaged>IsProtected</unmanaged>
|
|
<unmanaged-short>IsProtected</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaItem::IsProtected([Out] BOOL* pfProtected)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaItem.NumberOfStreams">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the number of streams (audio, video, and other) in the media item.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetNumberOfStreams']/*"/>
|
|
<msdn-id>dd374314</msdn-id>
|
|
<unmanaged>GetNumberOfStreams</unmanaged>
|
|
<unmanaged-short>GetNumberOfStreams</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetNumberOfStreams([Out] unsigned int* pdwStreamCount)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaItem.Characteristics">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets various flags that describe the media item.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetCharacteristics']/*"/>
|
|
<msdn-id>dd374311</msdn-id>
|
|
<unmanaged>GetCharacteristics</unmanaged>
|
|
<unmanaged-short>GetCharacteristics</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetCharacteristics([Out] unsigned int* pCharacteristics)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaItem.Metadata">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets a property store that contains metadata for the source, such as author or title.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaItem::GetMetadata']/*"/>
|
|
<msdn-id>dd798056</msdn-id>
|
|
<unmanaged>GetMetadata</unmanaged>
|
|
<unmanaged-short>GetMetadata</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaItem::GetMetadata([Out] IPropertyStore** ppMetadataStore)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMediaPlayer">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p> Contains methods to play media files.</p><p>The MFPlay player object exposes this interface. To get a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)"/></strong>.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer']/*"/>
|
|
<msdn-id>dd374329</msdn-id>
|
|
<unmanaged>IMFPMediaPlayer</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PMediaPlayer">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/>. (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.MediaFoundation.PMediaPlayer.Play">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p> Contains methods to play media files.</p><p>The MFPlay player object exposes this interface. To get a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)"/></strong>.</p>
|
|
</summary>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::Play']/*"/>
|
|
<msdn-id>dd374329</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::Play()</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::Play</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.Pause">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Pauses playback. While playback is paused, the most recent video frame is displayed, and audio is silent.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method completes asynchronously. When the operation completes, the application's <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> callback method is invoked. The event type is <strong><see cref="F:SharpDX.MediaFoundation.PEventType.Pause"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::Pause']/*"/>
|
|
<msdn-id>dd374353</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::Pause()</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::Pause</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.Stop">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Stops playback.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method completes asynchronously. When the operation completes, the application's <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> callback method is invoked. The event type is <strong><see cref="F:SharpDX.MediaFoundation.PEventType.Stop"/></strong>.</p><p>The current media item is still valid. After playback stops, the playback position resets to the beginning of the current media item. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::Stop']/*"/>
|
|
<msdn-id>dd374368</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::Stop()</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::Stop</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.FrameStep">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Steps forward one video frame.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Cannot frame step. Reasons for this error code include:</p> <ul> <li>There is no media item queued for playback.</li> <li>The current media item does not contain video.</li> </ul> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_RATE</strong></dt> </dl> </td><td> <p>The media source does not support frame stepping, or the current playback rate is negative.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> This method completes asynchronously. When the operation completes, the application's <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> callback method is invoked. The event type is <strong><see cref="F:SharpDX.MediaFoundation.PEventType.FrameStep"/></strong>.</p><p>The player object does not support frame stepping during reverse playback (that is, while the playback rate is negative).</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::FrameStep']/*"/>
|
|
<msdn-id>dd374336</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::FrameStep()</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::FrameStep</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.SetPosition(System.Guid,SharpDX.Win32.Variant)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Sets the playback position.</p>
|
|
</summary>
|
|
<param name="guidPositionType">No documentation.</param>
|
|
<param name="vPositionValueRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>HRESULT_FROM_WIN32( <see cref="F:SharpDX.Win32.ErrorCode.Seek"/> )</strong></strong></dt> </dl> </td><td> <p>The value of <em>pvPositionValue</em> is not valid.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>No media item has been queued.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If you call this method while playback is stopped, the new position takes effect after playback resumes.</p><p>This method completes asynchronously. When the operation completes, the application's <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> callback method is invoked. The event type is <strong><see cref="F:SharpDX.MediaFoundation.PEventType.PositionSet"/></strong>.</p><p>If playback was started before <strong>SetPosition</strong> is called, playback resumes at the new position. If playback was paused, the video is refreshed to display the current frame at the new position. </p><p>If you make two consecutive calls to <strong>SetPosition</strong> with <em>guidPositionType</em> equal to <strong>MFP_POSITIONTYPE_100NS</strong>, and the second call is made before the first call has completed, the second call supersedes the first. The status code for the superseded call is set to <strong>S_FALSE</strong> in the event data for that call. This behavior prevents excessive latency from repeated calls to <strong>SetPosition</strong>, as each call may force the media source to perform a relatively lengthy seek operation. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::SetPosition']/*"/>
|
|
<msdn-id>dd374363</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::SetPosition([In] const GUID& guidPositionType,[In] const PROPVARIANT* pvPositionValue)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::SetPosition</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetPosition(System.Guid,SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current playback position.</p>
|
|
</summary>
|
|
<param name="guidPositionType">No documentation.</param>
|
|
<param name="vPositionValueRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>No media item has been queued.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The playback position is calculated relative to the start time of the media item, which can be specified by calling <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.SetStartStopPosition(System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant},System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong>. For example, if you set the start time to 20 seconds and the source duration is 60 seconds, the range of values returned by <strong>GetPosition</strong> is 0?40 seconds.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetPosition']/*"/>
|
|
<msdn-id>dd374345</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetPosition([In] const GUID& guidPositionType,[Out] PROPVARIANT* pvPositionValue)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetPosition</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetDuration(System.Guid,SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the playback duration of the current media item.</p>
|
|
</summary>
|
|
<param name="guidPositionType">No documentation.</param>
|
|
<param name="vDurationValueRef">No documentation.</param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ATTRIBUTENOTFOUND</strong></dt> </dl> </td><td> <p>The media source does not have a duration. This error can occur with a live source, such as a video camera.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>There is no current media item.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method calculates the playback duration, taking into account the start and stop times for the media item. To set the start and stop times, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.SetStartStopPosition(System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant},System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong> on the media item. To get the actual duration of the underlying media file, regardless of start and stop times, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.GetDuration(System.Guid,SharpDX.Win32.Variant@)"/></strong>.</p><p>For example, suppose that you load a 30-second audio file and set the start time equal to 2 seconds and stop time equal to 10 seconds. The <strong><see cref="M:SharpDX.MediaFoundation.PMediaItem.GetDuration(System.Guid,SharpDX.Win32.Variant@)"/></strong> method will return 30 seconds, but the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.GetDuration(System.Guid,SharpDX.Win32.Variant@)"/></strong> method will return 8 seconds.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetDuration']/*"/>
|
|
<msdn-id>dd374340</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetDuration([In] const GUID& guidPositionType,[Out] PROPVARIANT* pvDurationValue)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetDuration</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.SetRate(System.Single)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Sets the playback rate.</p>
|
|
</summary>
|
|
<param name="flRate">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_OUT_OF_RANGE</strong></strong></dt> </dl> </td><td> <p>The <em>flRate</em> parameter is zero.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method completes asynchronously. When the operation completes, the application's <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> callback method is invoked. The event type is <strong><see cref="F:SharpDX.MediaFoundation.PEventType.RateSet"/></strong>.</p><p>The method sets the nearest supported rate, which will depend on the underlying media source. For example, if <em>flRate</em> is 50 and the source's maximum rate is 8? normal rate, the method will set the rate to 8.0. The actual rate is indicated in the event data for the <strong><see cref="F:SharpDX.MediaFoundation.PEventType.RateSet"/></strong> event.</p><p>To find the range of supported rates, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.GetSupportedRates(System.Boolean,System.Single@,System.Single@)"/></strong>.</p><p>This method does not support playback rates of zero, although Media Foundation defines a meaning for zero rates in some other contexts.</p><p>The new rate applies only to the current media item. Setting a new media item resets the playback rate to 1.0.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::SetRate']/*"/>
|
|
<msdn-id>dd374364</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::SetRate([In] float flRate)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::SetRate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetRate(System.Single@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current playback rate.</p>
|
|
</summary>
|
|
<param name="flRateRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetRate']/*"/>
|
|
<msdn-id>dd374346</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetRate([Out] float* pflRate)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetRate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetSupportedRates(System.Boolean,System.Single@,System.Single@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the range of supported playback rates.</p>
|
|
</summary>
|
|
<param name="fForwardDirection">No documentation.</param>
|
|
<param name="flSlowestRateRef">No documentation.</param>
|
|
<param name="flFastestRateRef">No documentation.</param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_UNSUPPORTED_RATE</strong></strong></dt> </dl> </td><td> <p>The current media item does not support playback in the requested direction (either forward or reverse).</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Playback rates are expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback speed, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
|
|
</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetSupportedRates']/*"/>
|
|
<msdn-id>dd374348</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetSupportedRates([In] BOOL fForwardDirection,[Out] float* pflSlowestRate,[Out] float* pflFastestRate)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetSupportedRates</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetState(SharpDX.MediaFoundation.PMediaplayerState@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current playback state of the MFPlay player object.</p>
|
|
</summary>
|
|
<param name="eStateRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This method can be called after the player object has been shut down.</p><p>Many of the <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/></strong> methods complete asynchronously. While an asynchronous operation is pending, the current state is not updated until the operation completes. When the operation completes, the application receives an event callback, and the new state is given in the <strong><see cref="T:SharpDX.MediaFoundation.PEventHeader"/></strong> structure that is passed to the callback.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetState']/*"/>
|
|
<msdn-id>dd374347</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetState([Out] MFP_MEDIAPLAYER_STATE* peState)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetState</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromURL(System.String,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Creates a media item from a URL.</p>
|
|
</summary>
|
|
<param name="wszURLRef">No documentation.</param>
|
|
<param name="fSync">No documentation.</param>
|
|
<param name="dwUserData">No documentation.</param>
|
|
<param name="mediaItemOut">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>Invalid request. This error can occur when <em>fSync</em> is <strong><see cref="F:SharpDX.Result.False"/></strong> and the application did not provide a callback interface. See Remarks.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_UNSUPPORTED_SCHEME</strong></strong></dt> </dl> </td><td> <p>Unsupported protocol. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method does not queue the media item for playback. To queue the item for playback, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.SetMediaItem(SharpDX.MediaFoundation.PMediaItem)"/></strong>.</p><p>The <strong>CreateMediaItemFromURL</strong> method can be called either synchronously or asynchronously: </p><ul> <li>If <em>fSync</em> is <strong>TRUE</strong>, the method completes synchronously. The <strong><see cref="T:SharpDX.MediaFoundation.PMediaItem"/></strong> reference is returned in the <em>ppMediaItem</em> parameter. </li> <li>If <em>fSync</em> is <strong><see cref="F:SharpDX.Result.False"/></strong>, the method completes asynchronously. When the operation completes, the application's <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> callback method is invoked. The event type is <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemCreated"/></strong>. The event data contains the <strong><see cref="T:SharpDX.MediaFoundation.PMediaItem"/></strong> reference for the new media item.</li> </ul><p>The callback interface is set when you first call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)"/></strong> to create the MFPlay player object. If you do not provide a callback interface, the <em>fSync</em> parameter must be <strong>TRUE</strong>. Otherwise, <strong>CreateMediaItemFromURL</strong> returns <strong>MF_E_INVALIDREQUEST</strong>. </p><p>If you make multiple asynchronous calls to <strong>CreateMediaItemFromURL</strong>, they are not guaranteed to complete in the same order. Use the <em>dwUserData</em> parameter to match created media items with pending requests.</p><p>Currently, this method returns <strong>MF_E_UNSUPPORTED_SCHEME</strong> if the URL specifies any of the following protocols: rtsp*, mms*, or mcast. If you want to use the Media Foundation network source with MFPlay, first use the Source Resolver to create the source, and then call <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromObject(SharpDX.ComObject,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong>.</p>Configuring the Source<p>Internally, this method creates a media source. To configure the media source, do the following:</p><ol> <li>Call <strong>QueryInterface</strong> on the <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/></strong> reference to get the <strong><see cref="T:SharpDX.ComObject"/></strong> interface.</li> <li>Call <strong>IPropertyStore::SetValue</strong> to set properties for the media source. For a list of configuration properties, see Configuring a Media Source. Third-party media sources may define custom properties.</li> <li>Call the <strong>CreateMediaItemFromURL</strong> method to create the media item.</li> </ol>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::CreateMediaItemFromURL']/*"/>
|
|
<msdn-id>dd374335</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::CreateMediaItemFromURL([In] const wchar_t* pwszURL,[In] BOOL fSync,[In] ULONG_PTR dwUserData,[Out, Optional] IMFPMediaItem** ppMediaItem)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::CreateMediaItemFromURL</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromObject(SharpDX.ComObject,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Creates a media item from an object.</p>
|
|
</summary>
|
|
<param name="iUnknownObjRef">No documentation.</param>
|
|
<param name="fSync">No documentation.</param>
|
|
<param name="dwUserData">No documentation.</param>
|
|
<param name="mediaItemOut">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>Invalid request. This error can occur when <em>fSync</em> is <strong><see cref="F:SharpDX.Result.False"/></strong> and the application did not provide a callback interface. See Remarks.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <em>pIUnknownObj</em> parameter must specify one of the following:</p><ul> <li>A reference to a media source. Media sources expose the <strong><see cref="T:SharpDX.MediaFoundation.MediaSource"/></strong> interface. It is the caller's responsibility to call <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Shutdown"/></strong> on the media source.</li> <li>A reference to a byte stream. Byte streams expose the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface. Internally, the method calls the <strong><see cref="M:SharpDX.MediaFoundation.SourceResolver.CreateObjectFromByteStream(SharpDX.MediaFoundation.ByteStream,System.String,System.Int32,SharpDX.ComObject,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong> method to create a media source from the byte stream. Therefore, a byte-stream handler must be registered for the byte stream. For more information about byte-stream handlers, see Scheme Handlers and Byte-Stream Handlers. </li> </ul><p>This method does not queue the media item for playback. To queue the item for playback, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.SetMediaItem(SharpDX.MediaFoundation.PMediaItem)"/></strong>.</p><p>The <strong>CreateMediaItemFromObject</strong> method can be called either synchronously or asynchronously: </p><ul> <li>If <em>fSync</em> is <strong>TRUE</strong>, the method completes synchronously. The <strong><see cref="T:SharpDX.MediaFoundation.PMediaItem"/></strong> reference is returned in the <em>ppMediaItem</em> parameter. </li> <li>If <em>fSync</em> is <strong><see cref="F:SharpDX.Result.False"/></strong>, the method completes asynchronously. When the operation completes, the application's <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> callback method is invoked. The event type is <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemCreated"/></strong>. The event data contains the <strong><see cref="T:SharpDX.MediaFoundation.PMediaItem"/></strong> reference for the new media item.</li> </ul><p>The callback interface is set when you first call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)"/></strong> to create the MFPlay player object. If you do not provide a callback interface, the <em>fSync</em> parameter must be <strong>TRUE</strong>. Otherwise, <strong>CreateMediaItemFromObject</strong> returns <strong>MF_E_INVALIDREQUEST</strong>. </p><p>If you make multiple asynchronous calls to <strong>CreateMediaItemFromObject</strong>, they are not guaranteed to complete in the same order. Use the <em>dwUserData</em> parameter to match created media items with pending requests.</p>Configuring the Source<p>If <em>pIUnknownObj</em> points to a byte stream, you can configure the media source by performing the following steps:</p><ol> <li>Call <strong>QueryInterface</strong> on the <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/></strong> reference to get the <strong><see cref="T:SharpDX.ComObject"/></strong> interface.</li> <li>Call <strong>IPropertyStore::SetValue</strong> to set properties for the media source. For a list of configuration properties, see Configuring a Media Source. Third-party media sources may define custom properties.</li> <li>Call the <strong>CreateMediaItemFromObject</strong> method to create the media item.</li> </ol><p>If <em>pIUnknownObj</em> points to a media source, you can configure the source at the time that you create it.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::CreateMediaItemFromObject']/*"/>
|
|
<msdn-id>dd374334</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::CreateMediaItemFromObject([In] IUnknown* pIUnknownObj,[In] BOOL fSync,[In] ULONG_PTR dwUserData,[Out, Optional] IMFPMediaItem** ppMediaItem)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::CreateMediaItemFromObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.SetMediaItem(SharpDX.MediaFoundation.PMediaItem)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Queues a media item for playback.</p>
|
|
</summary>
|
|
<param name="iMFPMediaItemRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_DRM_UNSUPPORTED</strong></strong></dt> </dl> </td><td> <p>The media item contains protected content. MFPlay currently does not support protected content.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_NO_AUDIO_PLAYBACK_DEVICE</strong></strong></dt> </dl> </td><td> <p>No audio playback device was found. This error can occur if the media source contains audio, but no audio playback devices are available on the system.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method completes asynchronously. When the operation completes, the application's <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> callback method is invoked. The event type is <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemSet"/></strong>.</p><p>To create a media item, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromObject(SharpDX.ComObject,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromURL(System.String,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong>. A media item must be used with the same MFPlay player object that created that item. If the media item was created by a different instance of the player object, <strong>SetMediaItem</strong> returns <strong>E_INVALIDARG</strong>.
|
|
</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::SetMediaItem']/*"/>
|
|
<msdn-id>dd374361</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::SetMediaItem([In] IMFPMediaItem* pIMFPMediaItem)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::SetMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.ClearMediaItem">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Clears the current media item.</p><p><strong>Note</strong>??This method is currently not implemented.</p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This method stops playback and releases the player object's references to the current media item.</p><p>This method completes asynchronously. When the operation completes, the application's <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> callback method is invoked. The event type is <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemCleared"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::ClearMediaItem']/*"/>
|
|
<msdn-id>dd374332</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::ClearMediaItem()</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::ClearMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetMediaItem(SharpDX.MediaFoundation.PMediaItem@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets a reference to the current media item.</p>
|
|
</summary>
|
|
<param name="iMFPMediaItemOut">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_FAIL</strong></strong></dt> </dl> </td><td> <p>There is no current media item.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_NOT_FOUND</strong></strong></dt> </dl> </td><td> <p>There is no current media item.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.SetMediaItem(SharpDX.MediaFoundation.PMediaItem)"/></strong> method is asynchronous. Therefore, while <strong>SetMediaItem</strong> is pending, <strong>GetMediaItem</strong> will not return the media item that was just set. Instead, the application should implement <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayerCallback"/></strong> interface and handle the <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemSet"/></strong> event. For more information, see Receiving Events From the Player.</p><p>The previous remark also applies to setting the media item in the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetMediaItem']/*"/>
|
|
<msdn-id>dd374342</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetMediaItem([Out] IMFPMediaItem** ppIMFPMediaItem)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetVolume(System.Single@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current audio volume.</p>
|
|
</summary>
|
|
<param name="flVolumeRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetVolume']/*"/>
|
|
<msdn-id>dd374351</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetVolume([Out] float* pflVolume)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetVolume</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.SetVolume(System.Single)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Sets the audio volume.</p>
|
|
</summary>
|
|
<param name="flVolume">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_OUT_OF_RANGE</strong></dt> </dl> </td><td> <p>The <em>flVolume</em> parameter is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If you call this method before playback starts, the setting is applied after playback starts.</p><p>This method does not change the master volume level for the player's audio session. Instead, it adjusts the per-channel volume levels for audio stream(s) that belong to the current media item. Other streams in the audio session are not affected. For more information, see Managing the Audio Session.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::SetVolume']/*"/>
|
|
<msdn-id>dd374366</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::SetVolume([In] float flVolume)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::SetVolume</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetBalance(System.Single@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current audio balance.</p>
|
|
</summary>
|
|
<param name="flBalanceRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetBalance']/*"/>
|
|
<msdn-id>dd374338</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetBalance([Out] float* pflBalance)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetBalance</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.SetBalance(System.Single)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Sets the audio balance.</p>
|
|
</summary>
|
|
<param name="flBalance">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_OUT_OF_RANGE</strong></strong></dt> </dl> </td><td> <p>The <em>flBalance</em> parameter is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If you call this method before playback starts, the setting is applied when playback starts.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::SetBalance']/*"/>
|
|
<msdn-id>dd374359</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::SetBalance([In] float flBalance)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::SetBalance</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetMute(System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Queries whether the audio is muted.</p>
|
|
</summary>
|
|
<param name="fMuteRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetMute']/*"/>
|
|
<msdn-id>dd374343</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetMute([Out] BOOL* pfMute)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetMute</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.SetMute(System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Mutes or unmutes the audio.</p>
|
|
</summary>
|
|
<param name="fMute">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>If you call this method before playback starts, the setting is applied after playback starts.</p><p> This method does not mute the entire audio session to which the player belongs. It mutes only the streams from the current media item. Other streams in the audio session are not affected. For more information, see Managing the Audio Session.
|
|
</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::SetMute']/*"/>
|
|
<msdn-id>dd374362</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::SetMute([In] BOOL fMute)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::SetMute</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetNativeVideoSize(SharpDX.DrawingSize@,SharpDX.DrawingSize@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the size and aspect ratio of the video. These values are computed before any scaling is done to fit the video into the destination window.</p>
|
|
</summary>
|
|
<param name="szVideoRef">No documentation.</param>
|
|
<param name="szARVideoRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The current media item does not contain video.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>At least one parameter must be non-<strong><c>null</c></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetNativeVideoSize']/*"/>
|
|
<msdn-id>dd374344</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetNativeVideoSize([Out, Optional] SIZE* pszVideo,[Out, Optional] SIZE* pszARVideo)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetNativeVideoSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetIdealVideoSize(SharpDX.DrawingSize@,SharpDX.DrawingSize@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the range of video sizes that can be displayed without significantly degrading performance or image quality.</p>
|
|
</summary>
|
|
<param name="szMinRef">No documentation.</param>
|
|
<param name="szMaxRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The current media item does not contain video.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>At least one parameter must be non-<strong><c>null</c></strong>. Sizes are given in pixels.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetIdealVideoSize']/*"/>
|
|
<msdn-id>dd374341</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetIdealVideoSize([Out, Optional] SIZE* pszMin,[Out, Optional] SIZE* pszMax)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetIdealVideoSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.SetVideoSourceRect(SharpDX.MediaFoundation.VideoNormalizedRect)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Sets the video source rectangle.</p><p>MFPlay clips the video to this rectangle and stretches the rectangle to fill the video window.</p>
|
|
</summary>
|
|
<param name="nrcSourceRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The current media item does not contain video.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>MFPlay stretches the source rectangle to fill the entire video window. By default, MFPlay maintains the source's correct aspect ratio, letterboxing if needed. The letterbox color is controlled by the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.SetBorderColor(SharpDX.Color4)"/></strong> method.</p><p>This method fails if no media item is currently set, or if the current media item does not contain video.</p><p> To set the video position before playback starts, call this method inside your event handler for the <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemSet"/></strong> event. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::SetVideoSourceRect']/*"/>
|
|
<msdn-id>dd743247</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::SetVideoSourceRect([In] const MFVideoNormalizedRect* pnrcSource)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::SetVideoSourceRect</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetVideoSourceRect(SharpDX.MediaFoundation.VideoNormalizedRect@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the video source rectangle.</p>
|
|
</summary>
|
|
<param name="nrcSourceRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The current media item does not contain video.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetVideoSourceRect']/*"/>
|
|
<msdn-id>dd743246</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetVideoSourceRect([Out] MFVideoNormalizedRect* pnrcSource)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetVideoSourceRect</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.SetAspectRatioMode(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Specifies whether the aspect ratio of the video is preserved during playback.</p>
|
|
</summary>
|
|
<param name="dwAspectRatioMode">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The current media item does not contain video.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method fails if no media item is currently set, or if the current media item does not contain video.</p><p>To set the aspect-ratio mode before playback starts, call this method inside your event handler for the <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemSet"/></strong> event. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::SetAspectRatioMode']/*"/>
|
|
<msdn-id>dd374358</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::SetAspectRatioMode([In] unsigned int dwAspectRatioMode)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::SetAspectRatioMode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetAspectRatioMode(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current aspect-ratio correction mode. This mode controls whether the aspect ratio of the video is preserved during playback.</p>
|
|
</summary>
|
|
<param name="dwAspectRatioModeRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The current media item does not contain video.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetAspectRatioMode']/*"/>
|
|
<msdn-id>dd374337</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetAspectRatioMode([Out] unsigned int* pdwAspectRatioMode)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetAspectRatioMode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetVideoWindow(System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the window where the video is displayed.</p>
|
|
</summary>
|
|
<param name="hwndVideoRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The video window is specified when you first call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)"/></strong> to create the MFPlay player object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetVideoWindow']/*"/>
|
|
<msdn-id>dd374350</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetVideoWindow([Out] HWND* phwndVideo)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetVideoWindow</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.UpdateVideo">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Updates the video frame.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The current media item does not contain video.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method when your application's video playback window receives either a <strong>WM_PAINT</strong> or <strong>WM_SIZE</strong> message. This method performs two functions: </p><ul> <li>Ensures that the video frame is repainted while playback is paused or stopped. </li> <li>Adjusts the displayed video to match the current size of the video window.</li> </ul><p><strong>Important</strong>??Call the GDI <strong>BeginPaint</strong> function before calling <strong>UpdateVideo</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::UpdateVideo']/*"/>
|
|
<msdn-id>dd743248</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::UpdateVideo()</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::UpdateVideo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.SetBorderColor(SharpDX.Color4)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Sets the color for the video border. The border color is used to letterbox the video.</p>
|
|
</summary>
|
|
<param name="clr">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The current media item does not contain video.</p> </td></tr> <tr><td> <dl> <dt><strong>M<strong>F_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method fails if no media item is currently set, or if the current media item does not contain video.</p><p>To set the border color before playback starts, call this method inside your event handler for the <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemSet"/></strong> event. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::SetBorderColor']/*"/>
|
|
<msdn-id>dd374360</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::SetBorderColor([In] COLORREF Clr)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::SetBorderColor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.GetBorderColor(SharpDX.Color4@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current color of the video border. The border color is used to letterbox the video.</p>
|
|
</summary>
|
|
<param name="clrRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The current media item does not contain video.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetBorderColor']/*"/>
|
|
<msdn-id>dd374339</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetBorderColor([Out] COLORREF* pClr)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::GetBorderColor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.InsertEffect(SharpDX.ComObject,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Applies an audio or video effect to playback.</p>
|
|
</summary>
|
|
<param name="effectRef">No documentation.</param>
|
|
<param name="fOptional">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDINDEX</strong></strong></dt> </dl> </td><td> <p>This effect was already added.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The object specified in the <em>pEffect</em> parameter can implement either a video effect or an audio effect. The effect is applied to any media items set after the method is called. It is not applied to the current media item. </p><p>For each media item, the effect is applied to the first selected stream of the matching type (audio or video). If a media item has two selected streams of the same type, the second stream does not receive the effect. The effect is ignored if the media item does not contain a stream that matches the effect type. For example, if you set a video effect and play a file that contains just audio, the video effect is ignored, although no error is raised.</p><p>The effect is applied to all subsequent media items, until the application removes the effect. To remove an effect, call <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.RemoveEffect(SharpDX.ComObject)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.RemoveAllEffects"/></strong>.</p><p>If you set multiple effects of the same type (audio or video), they are applied in the same order in which you call <strong>InsertEffect</strong>.</p>Remote Playback Optimizations<p>Audio and video effects might be incompatible with optimizations that are used for remote playback. The following remarks apply only to audio or video effects that are actually used during playback:</p><ul> <li>If you mark an audio or video effect as required, by setting <em>fOptional</em> to <strong><see cref="F:SharpDX.Result.False"/></strong>, MFPlay disables remote playback optimizations.</li> <li>Otherwise, if all audio/video effects are marked as optional, MFPlay might drop the effects, in order to enable remote playback optimizations.</li> </ul><p>In other words, required effects have priority over remote optimizations, but optional effects do not.</p><p>Remote optimizations might be disabled for other reasons. For example, they are disabled if you set the <strong><see cref="F:SharpDX.MediaFoundation.MfpCreationOptions.MfpOptionNoRemoteDesktopOptimization"/></strong> option when you create the player object. In that case, MFPlay will attempt to insert any optional effects. </p><p>Non-audio, non-video effects do not affect remote optimizations. Also, if you insert a required effect but the source does not contain any streams of that type, remote optimizations are not disabled.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::InsertEffect']/*"/>
|
|
<msdn-id>dd374352</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::InsertEffect([In] IUnknown* pEffect,[In] BOOL fOptional)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::InsertEffect</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.RemoveEffect(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Removes an effect that was added with the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.InsertEffect(SharpDX.ComObject,System.Boolean)"/></strong> method.</p>
|
|
</summary>
|
|
<param name="effectRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_FOUND</strong></dt> </dl> </td><td> <p>The effect was not found.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The change applies to the next media item that is set on the player. The effect is not removed from the current media item.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::RemoveEffect']/*"/>
|
|
<msdn-id>dd374356</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::RemoveEffect([In] IUnknown* pEffect)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::RemoveEffect</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.RemoveAllEffects">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Removes all effects that were added with the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.InsertEffect(SharpDX.ComObject,System.Boolean)"/></strong> method.</p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The change applies to the next media item that is set on the player. The effects are not removed from the current media item.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::RemoveAllEffects']/*"/>
|
|
<msdn-id>dd374355</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::RemoveAllEffects()</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::RemoveAllEffects</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayer.Shutdown">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Shuts down the MFPlay player object and releases any resources the object is using.</p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>After this method is called, most <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/></strong> methods return <strong>MF_E_SHUTDOWN</strong>. Also, any media items created from this instance of the player object are invalidated and most <strong><see cref="T:SharpDX.MediaFoundation.PMediaItem"/></strong> methods also return <strong>MF_E_SHUTDOWN</strong>.</p><p>The player object automatically shuts itself down when its reference count reaches zero. You can use the <strong>Shutdown</strong> method to shut down the player before all of the references have been released.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::Shutdown']/*"/>
|
|
<msdn-id>dd374367</msdn-id>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::Shutdown()</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer::Shutdown</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaPlayer.Rate">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current playback rate.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetRate']/*"/>
|
|
<msdn-id>dd374346</msdn-id>
|
|
<unmanaged>GetRate</unmanaged>
|
|
<unmanaged-short>GetRate</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetRate([Out] float* pflRate)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaPlayer.State">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current playback state of the MFPlay player object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method can be called after the player object has been shut down.</p><p>Many of the <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/></strong> methods complete asynchronously. While an asynchronous operation is pending, the current state is not updated until the operation completes. When the operation completes, the application receives an event callback, and the new state is given in the <strong><see cref="T:SharpDX.MediaFoundation.PEventHeader"/></strong> structure that is passed to the callback.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetState']/*"/>
|
|
<msdn-id>dd374347</msdn-id>
|
|
<unmanaged>GetState</unmanaged>
|
|
<unmanaged-short>GetState</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetState([Out] MFP_MEDIAPLAYER_STATE* peState)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaPlayer.MediaItem">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets a reference to the current media item.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.SetMediaItem(SharpDX.MediaFoundation.PMediaItem)"/></strong> method is asynchronous. Therefore, while <strong>SetMediaItem</strong> is pending, <strong>GetMediaItem</strong> will not return the media item that was just set. Instead, the application should implement <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayerCallback"/></strong> interface and handle the <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemSet"/></strong> event. For more information, see Receiving Events From the Player.</p><p>The previous remark also applies to setting the media item in the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetMediaItem']/*"/>
|
|
<msdn-id>dd374342</msdn-id>
|
|
<unmanaged>GetMediaItem</unmanaged>
|
|
<unmanaged-short>GetMediaItem</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetMediaItem([Out] IMFPMediaItem** ppIMFPMediaItem)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaPlayer.Volume">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current audio volume.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetVolume']/*"/>
|
|
<msdn-id>dd374351</msdn-id>
|
|
<unmanaged>GetVolume</unmanaged>
|
|
<unmanaged-short>GetVolume</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetVolume([Out] float* pflVolume)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaPlayer.Balance">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current audio balance.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetBalance']/*"/>
|
|
<msdn-id>dd374338</msdn-id>
|
|
<unmanaged>GetBalance</unmanaged>
|
|
<unmanaged-short>GetBalance</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetBalance([Out] float* pflBalance)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaPlayer.Mute">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Queries whether the audio is muted.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetMute']/*"/>
|
|
<msdn-id>dd374343</msdn-id>
|
|
<unmanaged>GetMute</unmanaged>
|
|
<unmanaged-short>GetMute</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetMute([Out] BOOL* pfMute)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaPlayer.VideoSourceRect">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the video source rectangle.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetVideoSourceRect']/*"/>
|
|
<msdn-id>dd743246</msdn-id>
|
|
<unmanaged>GetVideoSourceRect</unmanaged>
|
|
<unmanaged-short>GetVideoSourceRect</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetVideoSourceRect([Out] MFVideoNormalizedRect* pnrcSource)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaPlayer.AspectRatioMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current aspect-ratio correction mode. This mode controls whether the aspect ratio of the video is preserved during playback.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetAspectRatioMode']/*"/>
|
|
<msdn-id>dd374337</msdn-id>
|
|
<unmanaged>GetAspectRatioMode</unmanaged>
|
|
<unmanaged-short>GetAspectRatioMode</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetAspectRatioMode([Out] unsigned int* pdwAspectRatioMode)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaPlayer.VideoWindow">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the window where the video is displayed.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The video window is specified when you first call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)"/></strong> to create the MFPlay player object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetVideoWindow']/*"/>
|
|
<msdn-id>dd374350</msdn-id>
|
|
<unmanaged>GetVideoWindow</unmanaged>
|
|
<unmanaged-short>GetVideoWindow</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetVideoWindow([Out] HWND* phwndVideo)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMediaPlayer.BorderColor">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Gets the current color of the video border. The border color is used to letterbox the video.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayer::GetBorderColor']/*"/>
|
|
<msdn-id>dd374339</msdn-id>
|
|
<unmanaged>GetBorderColor</unmanaged>
|
|
<unmanaged-short>GetBorderColor</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMediaPlayer::GetBorderColor([Out] COLORREF* pClr)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMediaPlayerCallback">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Callback interface for the <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/></strong> interface.</p><p>To set the callback, pass an <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayerCallback"/></strong> reference to the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PCreateMediaPlayer(System.String,System.Boolean,System.Int32,SharpDX.MediaFoundation.PMediaPlayerCallback,System.IntPtr,SharpDX.MediaFoundation.PMediaPlayer@)"/></strong> function in the <em>pCallback</em> parameter. The application implements the <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayerCallback"/></strong> interface.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayerCallback']/*"/>
|
|
<msdn-id>dd374330</msdn-id>
|
|
<unmanaged>IMFPMediaPlayerCallback</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayerCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayerCallback.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PMediaPlayerCallback"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMediaPlayerCallback.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PMediaPlayerCallback">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PMediaPlayerCallback"/>. (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.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Called by the MFPlay player object to notify the application of a playback event.</p>
|
|
</summary>
|
|
<param name="eventHeaderRef">No documentation.</param>
|
|
<remarks>
|
|
<p> The specific type of playback event is given in the <strong>eEventType</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.PEventHeader"/></strong> structure. This structure contains information that is common to all of the event types. Some event types use extended structures. A set of macros is defined for casting the <em>pEventHeader</em> reference to the correct structure type. For more information, see <strong><see cref="T:SharpDX.MediaFoundation.PEventType"/></strong>. </p><p>It is safe to call <strong><see cref="T:SharpDX.MediaFoundation.PMediaPlayer"/></strong> and <strong><see cref="T:SharpDX.MediaFoundation.PMediaItem"/></strong> methods inside the <strong>OnMediaPlayer</strong> method. MFPlay is guaranteed not to reenter the <strong>OnMediaPlayer</strong> method. That is, calls to <strong>OnMediaPlayer</strong> are serialized, and the method will not be invoked again from inside <strong>OnMediaPlayer</strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMediaPlayerCallback::OnMediaPlayerEvent']/*"/>
|
|
<msdn-id>dd374331</msdn-id>
|
|
<unmanaged>void IMFPMediaPlayerCallback::OnMediaPlayerEvent([In] MFP_EVENT_HEADER* pEventHeader)</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayerCallback::OnMediaPlayerEvent</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMPClient">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Enables a media source to receive a reference to the <strong><see cref="T:SharpDX.MediaFoundation.PMPHost"/></strong> interface. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If a media source exposes this interface, the Protected Media Path (PMP) Media Session calls <strong>SetPMPHost</strong> with a reference to the <strong><see cref="T:SharpDX.MediaFoundation.PMPHost"/></strong> interface. The media source can use the <strong><see cref="T:SharpDX.MediaFoundation.PMPHost"/></strong> interface to create objects in the PMP process.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPClient']/*"/>
|
|
<msdn-id>ms702104</msdn-id>
|
|
<unmanaged>IMFPMPClient</unmanaged>
|
|
<unmanaged-short>IMFPMPClient</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPClient.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PMPClient"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPClient.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PMPClient">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PMPClient"/>. (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.MediaFoundation.PMPClient.SetPMPHost(SharpDX.MediaFoundation.PMPHost)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Provides a reference to the <strong><see cref="T:SharpDX.MediaFoundation.PMPHost"/></strong> interface. </p>
|
|
</summary>
|
|
<param name="pMPHostRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The <strong><see cref="T:SharpDX.MediaFoundation.PMPHost"/></strong> reference is apartment threaded. The media source must add the reference to the global interface table (GIT) before using it.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPClient::SetPMPHost']/*"/>
|
|
<msdn-id>ms703915</msdn-id>
|
|
<unmanaged>HRESULT IMFPMPClient::SetPMPHost([In] IMFPMPHost* pPMPHost)</unmanaged>
|
|
<unmanaged-short>IMFPMPClient::SetPMPHost</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMPClient.PMPHost">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Provides a reference to the <strong><see cref="T:SharpDX.MediaFoundation.PMPHost"/></strong> interface. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The <strong><see cref="T:SharpDX.MediaFoundation.PMPHost"/></strong> reference is apartment threaded. The media source must add the reference to the global interface table (GIT) before using it.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPClient::SetPMPHost']/*"/>
|
|
<msdn-id>ms703915</msdn-id>
|
|
<unmanaged>SetPMPHost</unmanaged>
|
|
<unmanaged-short>SetPMPHost</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMPClient::SetPMPHost([In] IMFPMPHost* pPMPHost)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMPClientApp">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPClientApp']/*"/>
|
|
<unmanaged>IMFPMPClientApp</unmanaged>
|
|
<unmanaged-short>IMFPMPClientApp</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPClientApp.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PMPClientApp"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPClientApp.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PMPClientApp">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PMPClientApp"/>. (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.MediaFoundation.PMPClientApp.SetPMPHost(SharpDX.MediaFoundation.PMPHostApp)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="pMPHostRef">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='IMFPMPClientApp::SetPMPHost']/*"/>
|
|
<unmanaged>HRESULT IMFPMPClientApp::SetPMPHost([In] IMFPMPHostApp* pPMPHost)</unmanaged>
|
|
<unmanaged-short>IMFPMPClientApp::SetPMPHost</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PMPClientApp.PMPHost">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPClientApp::SetPMPHost']/*"/>
|
|
<unmanaged>SetPMPHost</unmanaged>
|
|
<unmanaged-short>SetPMPHost</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPMPClientApp::SetPMPHost([In] IMFPMPHostApp* pPMPHost)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMPHost">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Enables a media source in the application process to create objects in the protected media path (PMP) process.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is used when a media source resides in the application process but the Media Session resides in a PMP process. The media source can use this interface to create objects in the PMP process. For example, to play DRM-protected content, the media source typically must create an input trust authority (ITA) in the PMP process. </p><p>To use this interface, the media source implements the <strong><see cref="T:SharpDX.MediaFoundation.PMPClient"/></strong> interface. The PMP Media Session calls <strong><see cref="M:SharpDX.MediaFoundation.PMPClient.SetPMPHost(SharpDX.MediaFoundation.PMPHost)"/></strong> on the media source, passing in a reference to the <strong><see cref="T:SharpDX.MediaFoundation.PMPHost"/></strong> interface.</p><p>You can also get a reference to this interface by calling <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> on the PMP Media Session, using the service identifier <strong>MF_PMP_SERVICE</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPHost']/*"/>
|
|
<msdn-id>ms705635</msdn-id>
|
|
<unmanaged>IMFPMPHost</unmanaged>
|
|
<unmanaged-short>IMFPMPHost</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPHost.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PMPHost"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPHost.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PMPHost">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PMPHost"/>. (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.MediaFoundation.PMPHost.LockProcess">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Blocks the protected media path (PMP) process from ending. </p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>When this method is called, it increments the lock count on the PMP process. For every call to this method, the application should make a corresponding call to <strong><see cref="M:SharpDX.MediaFoundation.PMPHost.UnlockProcess"/></strong>, which decrements the lock count. When the PMP process is ready to exit, it waits for about 3 seconds, or until the lock count reaches zero, before exiting.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPHost::LockProcess']/*"/>
|
|
<msdn-id>ms697003</msdn-id>
|
|
<unmanaged>HRESULT IMFPMPHost::LockProcess()</unmanaged>
|
|
<unmanaged-short>IMFPMPHost::LockProcess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPHost.UnlockProcess">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Decrements the lock count on the protected media path (PMP) process. Call this method once for each call to <strong><see cref="M:SharpDX.MediaFoundation.PMPHost.LockProcess"/></strong>. </p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPHost::UnlockProcess']/*"/>
|
|
<msdn-id>ms698984</msdn-id>
|
|
<unmanaged>HRESULT IMFPMPHost::UnlockProcess()</unmanaged>
|
|
<unmanaged-short>IMFPMPHost::UnlockProcess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPHost.CreateObjectByCLSID_(System.Guid,System.IntPtr,System.Guid,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates an object in the protect media path (PMP) process, from a CLSID. </p>
|
|
</summary>
|
|
<param name="clsid"><dd> <p> The CLSID of the object to create. </p> </dd></param>
|
|
<param name="streamRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.Win32.IStream"/></strong> interface. This parameter can be <strong><c>null</c></strong>. If this parameter is not <strong><c>null</c></strong>, the PMP host queries the created object for the <strong>IPersistStream</strong> interface and calls <strong>IPersistStream::Load</strong>, passing in the <em>pStream</em> reference. </p> </dd></param>
|
|
<param name="riid"><dd> <p> The interface identifier (IID) of the interface to retrieve. </p> </dd></param>
|
|
<param name="vOut"><dd> <p> Receives a reference to the requested interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> You can use the <em>pStream</em> parameter to initialize the object after it is created. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPHost::CreateObjectByCLSID']/*"/>
|
|
<msdn-id>ms698995</msdn-id>
|
|
<unmanaged>HRESULT IMFPMPHost::CreateObjectByCLSID([In] const GUID& clsid,[In] IStream* pStream,[In] const GUID& riid,[In] void** ppv)</unmanaged>
|
|
<unmanaged-short>IMFPMPHost::CreateObjectByCLSID</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMPHostApp">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPHostApp']/*"/>
|
|
<unmanaged>IMFPMPHostApp</unmanaged>
|
|
<unmanaged-short>IMFPMPHostApp</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPHostApp.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PMPHostApp"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPHostApp.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PMPHostApp">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PMPHostApp"/>. (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.MediaFoundation.PMPHostApp.LockProcess">
|
|
<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='IMFPMPHostApp::LockProcess']/*"/>
|
|
<unmanaged>HRESULT IMFPMPHostApp::LockProcess()</unmanaged>
|
|
<unmanaged-short>IMFPMPHostApp::LockProcess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPHostApp.UnlockProcess">
|
|
<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='IMFPMPHostApp::UnlockProcess']/*"/>
|
|
<unmanaged>HRESULT IMFPMPHostApp::UnlockProcess()</unmanaged>
|
|
<unmanaged-short>IMFPMPHostApp::UnlockProcess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPHostApp.ActivateClassById_(System.String,System.IntPtr,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="id">No documentation.</param>
|
|
<param name="streamRef">No documentation.</param>
|
|
<param name="riid">No documentation.</param>
|
|
<param name="vOut">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='IMFPMPHostApp::ActivateClassById']/*"/>
|
|
<unmanaged>HRESULT IMFPMPHostApp::ActivateClassById([In] const wchar_t* id,[In, Optional] IStream* pStream,[In] const GUID& riid,[Out] void** ppv)</unmanaged>
|
|
<unmanaged-short>IMFPMPHostApp::ActivateClassById</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMPServer">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates an object in the protected media path (PMP) process.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPServer']/*"/>
|
|
<msdn-id>ms704806</msdn-id>
|
|
<unmanaged>IMFPMPServer</unmanaged>
|
|
<unmanaged-short>IMFPMPServer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPServer.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PMPServer"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPServer.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PMPServer">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PMPServer"/>. (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.MediaFoundation.PMPServer.LockProcess">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Blocks the protected media path (PMP) process from ending.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When this method is called, it increments the lock count on the PMP process. For every call to this method, the application should make a corresponding call to <see cref="M:SharpDX.MediaFoundation.PMPServer.UnlockProcess"/>, which decrements the lock count. When the PMP process is ready to exit, it waits for about 3 seconds, or until the lock count reaches zero, before exiting.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPServer::LockProcess']/*"/>
|
|
<msdn-id>ms701590</msdn-id>
|
|
<unmanaged>HRESULT IMFPMPServer::LockProcess()</unmanaged>
|
|
<unmanaged-short>IMFPMPServer::LockProcess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPServer.UnlockProcess">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Decrements the lock count on the protected media path (PMP) process. Call this method once for each call to <see cref="M:SharpDX.MediaFoundation.PMPServer.LockProcess"/>.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPServer::UnlockProcess']/*"/>
|
|
<msdn-id>ms696204</msdn-id>
|
|
<unmanaged>HRESULT IMFPMPServer::UnlockProcess()</unmanaged>
|
|
<unmanaged-short>IMFPMPServer::UnlockProcess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PMPServer.CreateObjectByCLSID(System.Guid,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Creates an object in the protected media path (PMP) process.</p>
|
|
</summary>
|
|
<param name="clsid"><dd> <p>CLSID of the object to create.</p> </dd></param>
|
|
<param name="riid"><dd> <p>Interface identifier of the interface to retrieve.</p> </dd></param>
|
|
<param name="objectOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPMPServer::CreateObjectByCLSID']/*"/>
|
|
<msdn-id>ms704806</msdn-id>
|
|
<unmanaged>HRESULT IMFPMPServer::CreateObjectByCLSID([In] const GUID& clsid,[In] const GUID& riid,[Out] void** ppObject)</unmanaged>
|
|
<unmanaged-short>IMFPMPServer::CreateObjectByCLSID</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PresentationClock">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Represents a presentation clock, which is used to schedule when samples are rendered and to synchronize multiple streams.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To create a new instance of the presentation clock, call the <see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePresentationClock(SharpDX.MediaFoundation.PresentationClock@)"/> function. The presentation clock must have a time source, which is an object that provides the clock times. For example, the audio renderer is a time source that uses the sound card to drive the clock. Time sources expose the <see cref="T:SharpDX.MediaFoundation.PresentationTimeSource"/> interface. To set the time source, call <strong>SetTimeSource</strong>. The presentation clock does not begin running until the <strong>Start</strong> method is called.</p><p>To get the presentation clock from the Media Session, call <see cref="M:SharpDX.MediaFoundation.MediaSession.GetClock(SharpDX.MediaFoundation.Clock@)"/>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock']/*"/>
|
|
<msdn-id>ms701581</msdn-id>
|
|
<unmanaged>IMFPresentationClock</unmanaged>
|
|
<unmanaged-short>IMFPresentationClock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationClock.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PresentationClock"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationClock.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PresentationClock">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PresentationClock"/>. (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.MediaFoundation.PresentationClock.SetTimeSource(SharpDX.MediaFoundation.PresentationTimeSource)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the time source for the presentation clock. The time source is the object that drives the clock by providing the current time.</p>
|
|
</summary>
|
|
<param name="timeSourceRef"><dd> <p>Pointer to the <see cref="T:SharpDX.MediaFoundation.PresentationTimeSource"/> interface of the time source.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CLOCK_NOT_SIMPLE</strong></dt> </dl> </td><td> <p>The time source does not have a frequency of 10 MHz.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The time source has not been initialized.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The presentation clock cannot start until it has a time source.</p><p>The time source is automatically registered to receive state change notifications from the clock, through the time source's <see cref="T:SharpDX.MediaFoundation.ClockStateSink"/> interface, which all time sources must implement.</p><p>This time source have a frequency of 10 MHz. See <see cref="M:SharpDX.MediaFoundation.Clock.GetClockCharacteristics(System.Int32@)"/>. If not, the method returns MF_E_CLOCK_NOT_SIMPLE.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock::SetTimeSource']/*"/>
|
|
<msdn-id>ms694835</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationClock::SetTimeSource([In, Optional] IMFPresentationTimeSource* pTimeSource)</unmanaged>
|
|
<unmanaged-short>IMFPresentationClock::SetTimeSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationClock.GetTimeSource(SharpDX.MediaFoundation.PresentationTimeSource@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the clock's presentation time source.</p>
|
|
</summary>
|
|
<param name="timeSourceOut"><dd> <p>Receives a reference to the time source's <see cref="T:SharpDX.MediaFoundation.PresentationTimeSource"/> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CLOCK_NO_TIME_SOURCE</strong></dt> </dl> </td><td> <p>No time source was set on this clock.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock::GetTimeSource']/*"/>
|
|
<msdn-id>ms704730</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationClock::GetTimeSource([Out] IMFPresentationTimeSource** ppTimeSource)</unmanaged>
|
|
<unmanaged-short>IMFPresentationClock::GetTimeSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationClock.GetTime(System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves the latest clock time. </p>
|
|
</summary>
|
|
<param name="hnsClockTimeRef"><dd> <p> Receives the latest clock time, in 100-nanosecond units. The time is relative to when the clock was last started. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CLOCK_NO_TIME_SOURCE</strong></dt> </dl> </td><td> <p> The clock does not have a presentation time source. Call <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.SetTimeSource(SharpDX.MediaFoundation.PresentationTimeSource)"/></strong>. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method does not attempt to smooth out jitter or otherwise account for any inaccuracies in the clock time.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock::GetTime']/*"/>
|
|
<msdn-id>ms696209</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationClock::GetTime([Out] longlong* phnsClockTime)</unmanaged>
|
|
<unmanaged-short>IMFPresentationClock::GetTime</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationClock.AddClockStateSink(SharpDX.MediaFoundation.ClockStateSink)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Registers an object to be notified whenever the clock starts, stops, or pauses, or changes rate.</p>
|
|
</summary>
|
|
<param name="stateSinkRef"><dd> <p>Pointer to the object's <see cref="T:SharpDX.MediaFoundation.ClockStateSink"/> interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Before releasing the object, call <see cref="M:SharpDX.MediaFoundation.PresentationClock.RemoveClockStateSink(SharpDX.MediaFoundation.ClockStateSink)"/> to unregister the object for state-change notifications.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock::AddClockStateSink']/*"/>
|
|
<msdn-id>ms703129</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationClock::AddClockStateSink([In, Optional] IMFClockStateSink* pStateSink)</unmanaged>
|
|
<unmanaged-short>IMFPresentationClock::AddClockStateSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationClock.RemoveClockStateSink(SharpDX.MediaFoundation.ClockStateSink)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Unregisters an object that is receiving state-change notifications from the clock.</p>
|
|
</summary>
|
|
<param name="stateSinkRef"><dd> <p>Pointer to the object's <see cref="T:SharpDX.MediaFoundation.ClockStateSink"/> interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock::RemoveClockStateSink']/*"/>
|
|
<msdn-id>ms703032</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationClock::RemoveClockStateSink([In, Optional] IMFClockStateSink* pStateSink)</unmanaged>
|
|
<unmanaged-short>IMFPresentationClock::RemoveClockStateSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationClock.Start(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Starts the presentation clock.</p>
|
|
</summary>
|
|
<param name="llClockStartOffset"><dd> <p>Initial starting time, in 100-nanosecond units. At the time the <strong>Start</strong> method is called, the clock's <see cref="M:SharpDX.MediaFoundation.PresentationClock.GetTime(System.Int64@)"/> method returns this value, and the clock time increments from there. If the value is PRESENTATION_CURRENT_POSITION, the clock starts from its current position. Use this value if the clock is paused and you want to restart it from the same position.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CLOCK_NO_TIME_SOURCE</strong></dt> </dl> </td><td> <p>No time source was set on this clock.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is valid in all states (stopped, paused, or running).</p><p>If the clock is paused and restarted from the same position (<em>llClockStartOffset</em> is PRESENTATION_CURRENT_POSITION), the presentation clock sends an <see cref="M:SharpDX.MediaFoundation.ClockStateSink.OnClockRestart(System.Int64)"/> notification. Otherwise, the clock sends an <see cref="M:SharpDX.MediaFoundation.ClockStateSink.OnClockStart(System.Int64,System.Int64)"/> notification.</p><p>The presentation clock initiates the state change by calling <strong>OnClockStart</strong> or <strong>OnClockRestart</strong> on the clock's time source. This call is made synchronously. If it fails, the state change does not occur. If the call succeeds, the state changes, and the clock notifies the other state-change subscribers by calling their <strong>OnClockStart</strong> or <strong>OnClockRestart</strong> methods. These calls are made asynchronously.</p><p>If the clock is already running, calling <strong>Start</strong> again has the effect of seeking the clock to the new <em>StartOffset</em> position.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock::Start']/*"/>
|
|
<msdn-id>ms702290</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationClock::Start([In] longlong llClockStartOffset)</unmanaged>
|
|
<unmanaged-short>IMFPresentationClock::Start</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationClock.Stop">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Stops the presentation clock. While the clock is stopped, the clock time does not advance, and the clock's <see cref="M:SharpDX.MediaFoundation.PresentationClock.GetTime(System.Int64@)"/> method returns zero.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CLOCK_NO_TIME_SOURCE</strong></dt> </dl> </td><td> <p>No time source was set on this clock.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CLOCK_STATE_ALREADY_SET</strong></dt> </dl> </td><td> <p>The clock is already stopped.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is valid when the clock is running or paused.</p><p>The presentation clock initiates the state change by calling <see cref="M:SharpDX.MediaFoundation.ClockStateSink.OnClockStop(System.Int64)"/> on the clock's time source. This call is made synchronously. If it fails, the state change does not occur. If the call succeeds, the state changes, and the clock notifies the other state-change subscribers by calling their <strong>OnClockStop</strong> methods. These calls are made asynchronously.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock::Stop']/*"/>
|
|
<msdn-id>ms697195</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationClock::Stop()</unmanaged>
|
|
<unmanaged-short>IMFPresentationClock::Stop</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationClock.Pause">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Pauses the presentation clock. While the clock is paused, the clock time does not advance, and the clock's <see cref="M:SharpDX.MediaFoundation.PresentationClock.GetTime(System.Int64@)"/> returns the time at which the clock was paused.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CLOCK_NO_TIME_SOURCE</strong></dt> </dl> </td><td> <p>No time source was set on this clock.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_CLOCK_STATE_ALREADY_SET</strong></dt> </dl> </td><td> <p>The clock is already paused.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The clock is stopped. This request is not valid when the clock is stopped.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is valid when the clock is running. It is not valid when the clock is paused or stopped.</p><p>The presentation clock initiates the state change by calling <see cref="M:SharpDX.MediaFoundation.ClockStateSink.OnClockPause(System.Int64)"/> on the clock's time source. This call is made synchronously. If it fails, the state change does not occur. If the call succeeds, the state changes, and the clock notifies the other state-change subscribers by calling their <strong>OnClockPause</strong> methods. These calls are made asynchronously.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock::Pause']/*"/>
|
|
<msdn-id>ms696201</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationClock::Pause()</unmanaged>
|
|
<unmanaged-short>IMFPresentationClock::Pause</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PresentationClock.TimeSource">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the clock's presentation time source.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock::GetTimeSource']/*"/>
|
|
<msdn-id>ms704730</msdn-id>
|
|
<unmanaged>GetTimeSource</unmanaged>
|
|
<unmanaged-short>GetTimeSource</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPresentationClock::GetTimeSource([Out] IMFPresentationTimeSource** ppTimeSource)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PresentationClock.Time">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Retrieves the latest clock time. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method does not attempt to smooth out jitter or otherwise account for any inaccuracies in the clock time.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationClock::GetTime']/*"/>
|
|
<msdn-id>ms696209</msdn-id>
|
|
<unmanaged>GetTime</unmanaged>
|
|
<unmanaged-short>GetTime</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPresentationClock::GetTime([Out] longlong* phnsClockTime)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PresentationDescriptor">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Describes the details of a presentation. A <em>presentation</em> is a set of related media streams that share a common presentation time. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Presentation descriptors are used to configure media sources and some media sinks. To get the presentation descriptor from a media source, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.CreatePresentationDescriptor(SharpDX.MediaFoundation.PresentationDescriptor@)"/></strong>. To create a new presentation descriptor, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreatePresentationDescriptor(System.Int32,SharpDX.MediaFoundation.StreamDescriptor[],SharpDX.MediaFoundation.PresentationDescriptor@)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationDescriptor']/*"/>
|
|
<msdn-id>ms703990</msdn-id>
|
|
<unmanaged>IMFPresentationDescriptor</unmanaged>
|
|
<unmanaged-short>IMFPresentationDescriptor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationDescriptor.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationDescriptor.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PresentationDescriptor">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/>. (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.MediaFoundation.PresentationDescriptor.GetStreamDescriptorCount(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of stream descriptors in the presentation. Each stream descriptor contains information about one stream in the media source. To retrieve a stream descriptor, call the <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.GetStreamDescriptorByIndex(System.Int32,System.Boolean@,SharpDX.MediaFoundation.StreamDescriptor@)"/></strong> method.</p>
|
|
</summary>
|
|
<param name="dwDescriptorCountRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationDescriptor::GetStreamDescriptorCount']/*"/>
|
|
<msdn-id>ms701621</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationDescriptor::GetStreamDescriptorCount([Out] unsigned int* pdwDescriptorCount)</unmanaged>
|
|
<unmanaged-short>IMFPresentationDescriptor::GetStreamDescriptorCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationDescriptor.GetStreamDescriptorByIndex(System.Int32,System.Boolean@,SharpDX.MediaFoundation.StreamDescriptor@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a stream descriptor for a stream in the presentation. The stream descriptor contains information about the stream.</p>
|
|
</summary>
|
|
<param name="dwIndex"><dd> <p>Zero-based index of the stream. To find the number of streams in the presentation, call the <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.GetStreamDescriptorCount(System.Int32@)"/></strong> method.</p> </dd></param>
|
|
<param name="fSelectedRef"><dd> <p>Receives a Boolean value. The value is <strong>TRUE</strong> if the stream is currently selected, or <strong><see cref="F:SharpDX.Result.False"/></strong> if the stream is currently deselected. If a stream is selected, the media source generates data for that stream when <strong><see cref="M:SharpDX.MediaFoundation.MediaSource.Start(SharpDX.MediaFoundation.PresentationDescriptor,System.Nullable{System.Guid},System.Nullable{SharpDX.Win32.Variant})"/></strong> is called. The media source will not generated data for deselected streams. To select a stream, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.SelectStream(System.Int32)"/></strong>.To deselect a stream, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.DeselectStream(System.Int32)"/></strong>.</p> </dd></param>
|
|
<param name="descriptorOut"><dd> <p>Receives a reference to the stream descriptor's <strong><see cref="T:SharpDX.MediaFoundation.StreamDescriptor"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationDescriptor::GetStreamDescriptorByIndex']/*"/>
|
|
<msdn-id>ms694924</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationDescriptor::GetStreamDescriptorByIndex([In] unsigned int dwIndex,[Out] BOOL* pfSelected,[Out] IMFStreamDescriptor** ppDescriptor)</unmanaged>
|
|
<unmanaged-short>IMFPresentationDescriptor::GetStreamDescriptorByIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationDescriptor.SelectStream(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Selects a stream in the presentation.</p>
|
|
</summary>
|
|
<param name="dwDescriptorIndex"><dd> <p>The stream number to select, indexed from zero. To find the number of streams in the presentation, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.GetStreamDescriptorCount(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>dwDescriptorIndex</em> is out of range.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If a stream is selected, the media source will generate data for that stream. The media source will not generated data for deselected streams. To deselect a stream, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.DeselectStream(System.Int32)"/></strong>. </p><p> To query whether a stream is selected, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.GetStreamDescriptorByIndex(System.Int32,System.Boolean@,SharpDX.MediaFoundation.StreamDescriptor@)"/></strong>. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationDescriptor::SelectStream']/*"/>
|
|
<msdn-id>ms696272</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationDescriptor::SelectStream([In] unsigned int dwDescriptorIndex)</unmanaged>
|
|
<unmanaged-short>IMFPresentationDescriptor::SelectStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationDescriptor.DeselectStream(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Deselects a stream in the presentation.</p>
|
|
</summary>
|
|
<param name="dwDescriptorIndex"><dd> <p> The stream number to deselect, indexed from zero. To find the number of streams in the presentation, call the <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.GetStreamDescriptorCount(System.Int32@)"/></strong> method. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>dwDescriptorIndex</em> is out of range. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If a stream is deselected, no data is generated for that stream. To select the stream again, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.SelectStream(System.Int32)"/></strong>. </p><p> To query whether a stream is selected, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.GetStreamDescriptorByIndex(System.Int32,System.Boolean@,SharpDX.MediaFoundation.StreamDescriptor@)"/></strong>. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationDescriptor::DeselectStream']/*"/>
|
|
<msdn-id>ms696266</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationDescriptor::DeselectStream([In] unsigned int dwDescriptorIndex)</unmanaged>
|
|
<unmanaged-short>IMFPresentationDescriptor::DeselectStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationDescriptor.Clone(SharpDX.MediaFoundation.PresentationDescriptor@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Creates a copy of this presentation descriptor.</p>
|
|
</summary>
|
|
<param name="presentationDescriptorOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/></strong> interface of the new presentation descriptor. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> This method performs a shallow copy of the presentation descriptor. The stream descriptors are not cloned. Therefore, use caution when modifying the presentation presentation descriptor or its stream descriptors. </p><p> If the original presentation descriptor is from a media source, do not modify the presentation descriptor unless the source is stopped. If you use the presentation descriptor to configure a media sink, do not modify the presentation descriptor after the sink is configured. </p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationDescriptor::Clone']/*"/>
|
|
<msdn-id>ms694028</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationDescriptor::Clone([Out] IMFPresentationDescriptor** ppPresentationDescriptor)</unmanaged>
|
|
<unmanaged-short>IMFPresentationDescriptor::Clone</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PresentationDescriptor.StreamDescriptorCount">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of stream descriptors in the presentation. Each stream descriptor contains information about one stream in the media source. To retrieve a stream descriptor, call the <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.GetStreamDescriptorByIndex(System.Int32,System.Boolean@,SharpDX.MediaFoundation.StreamDescriptor@)"/></strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationDescriptor::GetStreamDescriptorCount']/*"/>
|
|
<msdn-id>ms701621</msdn-id>
|
|
<unmanaged>GetStreamDescriptorCount</unmanaged>
|
|
<unmanaged-short>GetStreamDescriptorCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPresentationDescriptor::GetStreamDescriptorCount([Out] unsigned int* pdwDescriptorCount)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PresentationTimeSource">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Provides the clock times for the presentation clock. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is implemented by presentation time sources. A presentation time source is an object that provides the clock time for the presentation clock. For example, the audio renderer is a presentation time source. The rate at which the audio renderer consumes audio samples determines the clock time. If the audio format is 44100 samples per second, the audio renderer will report that one second has passed for every 44100 audio samples it plays. In this case, the timing is provided by the sound card.</p><p>To set the presentation time source on the presentation clock, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationClock.SetTimeSource(SharpDX.MediaFoundation.PresentationTimeSource)"/></strong> with a reference to the time source's <strong><see cref="T:SharpDX.MediaFoundation.PresentationTimeSource"/></strong> interface.</p><p>A presentation time source must also implement the <strong><see cref="T:SharpDX.MediaFoundation.ClockStateSink"/></strong> interface. The presentaton clock uses this interface to notify the time source when the clock state changes.</p><p>Media Foundation provides a presentation time source that is based on the system clock. To create this object, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSystemTimeSource(SharpDX.MediaFoundation.PresentationTimeSource@)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationTimeSource']/*"/>
|
|
<msdn-id>ms704711</msdn-id>
|
|
<unmanaged>IMFPresentationTimeSource</unmanaged>
|
|
<unmanaged-short>IMFPresentationTimeSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationTimeSource.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.PresentationTimeSource"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.PresentationTimeSource.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.PresentationTimeSource">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.PresentationTimeSource"/>. (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.MediaFoundation.PresentationTimeSource.GetUnderlyingClock(SharpDX.MediaFoundation.Clock@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the underlying clock that the presentation time source uses to generate its clock times.</p>
|
|
</summary>
|
|
<param name="clockOut"><dd> <p>Receives a reference to the clock's <strong><see cref="T:SharpDX.MediaFoundation.Clock"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_CLOCK</strong></dt> </dl> </td><td> <p>This time source does not expose an underlying clock.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>A presentation time source must support stopping, starting, pausing, and rate changes. However, in many cases the time source derives its clock times from a hardware clock or other device. The underlying clock is always running, and might not support rate changes.</p><p>Optionally, a time source can expose the underlying clock by implementing this method. The underlying clock is always running, even when the presentation time source is paused or stopped. (Therefore, the underlying clock returns the <see cref="F:SharpDX.MediaFoundation.ClockCharacteristicsFlags.AlwaysRunning"/> flag in the <strong><see cref="M:SharpDX.MediaFoundation.Clock.GetClockCharacteristics(System.Int32@)"/></strong> method).</p><p>The underlying clock is useful if you want to make decisions based on the clock times while the presentation clock is stopped or paused.</p><p>If the time source does not expose an underlying clock, the method returns MF_E_NO_CLOCK.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationTimeSource::GetUnderlyingClock']/*"/>
|
|
<msdn-id>ms694071</msdn-id>
|
|
<unmanaged>HRESULT IMFPresentationTimeSource::GetUnderlyingClock([Out] IMFClock** ppClock)</unmanaged>
|
|
<unmanaged-short>IMFPresentationTimeSource::GetUnderlyingClock</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PresentationTimeSource.UnderlyingClock">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the underlying clock that the presentation time source uses to generate its clock times.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>A presentation time source must support stopping, starting, pausing, and rate changes. However, in many cases the time source derives its clock times from a hardware clock or other device. The underlying clock is always running, and might not support rate changes.</p><p>Optionally, a time source can expose the underlying clock by implementing this method. The underlying clock is always running, even when the presentation time source is paused or stopped. (Therefore, the underlying clock returns the <see cref="F:SharpDX.MediaFoundation.ClockCharacteristicsFlags.AlwaysRunning"/> flag in the <strong><see cref="M:SharpDX.MediaFoundation.Clock.GetClockCharacteristics(System.Int32@)"/></strong> method).</p><p>The underlying clock is useful if you want to make decisions based on the clock times while the presentation clock is stopped or paused.</p><p>If the time source does not expose an underlying clock, the method returns MF_E_NO_CLOCK.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFPresentationTimeSource::GetUnderlyingClock']/*"/>
|
|
<msdn-id>ms694071</msdn-id>
|
|
<unmanaged>GetUnderlyingClock</unmanaged>
|
|
<unmanaged-short>GetUnderlyingClock</unmanaged-short>
|
|
<unmanaged>HRESULT IMFPresentationTimeSource::GetUnderlyingClock([Out] IMFClock** ppClock)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ProtectedEnvironmentAccess">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Provides a method that allows content protection systems to perform a handshake with the protected environment. This is needed because the <strong>CreateFile</strong> and <strong>DeviceIoControl</strong> APIs are not available to Metro style apps.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>See <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateProtectedEnvironmentAccess(SharpDX.MediaFoundation.ProtectedEnvironmentAccess@)"/></strong> for an example of how to create and use an <strong><see cref="T:SharpDX.MediaFoundation.ProtectedEnvironmentAccess"/></strong> object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFProtectedEnvironmentAccess']/*"/>
|
|
<msdn-id>hh448045</msdn-id>
|
|
<unmanaged>IMFProtectedEnvironmentAccess</unmanaged>
|
|
<unmanaged-short>IMFProtectedEnvironmentAccess</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ProtectedEnvironmentAccess.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ProtectedEnvironmentAccess"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ProtectedEnvironmentAccess.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ProtectedEnvironmentAccess">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ProtectedEnvironmentAccess"/>. (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.MediaFoundation.ProtectedEnvironmentAccess.Call(System.Int32,System.Byte[],System.Int32,System.Byte[])">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Allows content protection systems to access the protected environment.</p>
|
|
</summary>
|
|
<param name="inputLength"><dd> <p>The length in bytes of the input data.</p> </dd></param>
|
|
<param name="input"><dd> <p>A reference to the input data.</p> </dd></param>
|
|
<param name="outputLength"><dd> <p>The length in bytes of the output data.</p> </dd></param>
|
|
<param name="output"><dd> <p>A reference to the output data.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>See <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateProtectedEnvironmentAccess(SharpDX.MediaFoundation.ProtectedEnvironmentAccess@)"/></strong> for an example of how to create an <strong><see cref="T:SharpDX.MediaFoundation.ProtectedEnvironmentAccess"/></strong> object and use the <strong>Call</strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFProtectedEnvironmentAccess::Call']/*"/>
|
|
<msdn-id>hh448046</msdn-id>
|
|
<unmanaged>HRESULT IMFProtectedEnvironmentAccess::Call([In] unsigned int inputLength,[In, Buffer] const unsigned char* input,[In] unsigned int outputLength,[Out, Buffer] unsigned char* output)</unmanaged>
|
|
<unmanaged-short>IMFProtectedEnvironmentAccess::Call</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ProtectedEnvironmentAccess.ReadGRL(System.Int32@,System.Byte[])">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="outputLength">No documentation.</param>
|
|
<param name="output">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='IMFProtectedEnvironmentAccess::ReadGRL']/*"/>
|
|
<unmanaged>HRESULT IMFProtectedEnvironmentAccess::ReadGRL([Out] unsigned int* outputLength,[Out, Buffer] unsigned char** output)</unmanaged>
|
|
<unmanaged-short>IMFProtectedEnvironmentAccess::ReadGRL</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.QualityAdvise">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Enables the quality manager to adjust the audio or video quality of a component in the pipeline.</p><p>This interface is exposed by pipeline components that can adjust their quality. Typically it is exposed by decoders and stream sinks. For example, the enhanced video renderer (EVR) implements this interface. However, media sources can also implement this interface.</p><p>To get a reference to this interface from a media source, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> with the service identifier MF_QUALITY_SERVICES. For all other pipeline objects (transforms and media sinks), call <strong>QueryInterface</strong>.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The quality manager typically obtains this interface when the quality manager's <strong><see cref="M:SharpDX.MediaFoundation.QualityManager.NotifyTopology(SharpDX.MediaFoundation.Topology)"/></strong> method is called.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdvise']/*"/>
|
|
<msdn-id>ms695241</msdn-id>
|
|
<unmanaged>IMFQualityAdvise</unmanaged>
|
|
<unmanaged-short>IMFQualityAdvise</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdvise.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.QualityAdvise"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdvise.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.QualityAdvise">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.QualityAdvise"/>. (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.MediaFoundation.QualityAdvise.SetDropMode(SharpDX.MediaFoundation.QualityDropMode)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the drop mode. In drop mode, a component drops samples, more or less aggressively depending on the level of the drop mode.</p>
|
|
</summary>
|
|
<param name="eDropMode"><dd> <p>Requested drop mode, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.QualityDropMode"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_MORE_DROP_MODES</strong></dt> </dl> </td><td> <p>The component does not support the specified mode or any higher modes.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If this method is called on a media source, the media source might switch between thinned and non-thinned output. If that occurs, the affected streams will send an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamThinMode"/> event to indicate the transition. The operation is asynchronous; after <strong>SetDropMode</strong> returns, you might receive samples that were queued before the transition. The <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamThinMode"/> event marks the exact point in the stream where the transition occurs.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdvise::SetDropMode']/*"/>
|
|
<msdn-id>ms694861</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityAdvise::SetDropMode([In] MF_QUALITY_DROP_MODE eDropMode)</unmanaged>
|
|
<unmanaged-short>IMFQualityAdvise::SetDropMode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdvise.SetQualityLevel(SharpDX.MediaFoundation.QualityLevel)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the quality level. The quality level determines how the component consumes or produces samples.</p>
|
|
</summary>
|
|
<param name="eQualityLevel"><dd> <p>Requested quality level, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.QualityLevel"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_MORE_QUALITY_LEVELS</strong></dt> </dl> </td><td> <p>The component does not support the specified quality level or any levels below it.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdvise::SetQualityLevel']/*"/>
|
|
<msdn-id>ms705619</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityAdvise::SetQualityLevel([In] MF_QUALITY_LEVEL eQualityLevel)</unmanaged>
|
|
<unmanaged-short>IMFQualityAdvise::SetQualityLevel</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdvise.GetDropMode(SharpDX.MediaFoundation.QualityDropMode@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the current drop mode.</p>
|
|
</summary>
|
|
<param name="eDropModeRef"><dd> <p>Receives the drop mode, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.QualityDropMode"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdvise::GetDropMode']/*"/>
|
|
<msdn-id>ms702987</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityAdvise::GetDropMode([Out] MF_QUALITY_DROP_MODE* peDropMode)</unmanaged>
|
|
<unmanaged-short>IMFQualityAdvise::GetDropMode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdvise.GetQualityLevel(SharpDX.MediaFoundation.QualityLevel@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the current quality level.</p>
|
|
</summary>
|
|
<param name="eQualityLevelRef"><dd> <p>Receives the quality level, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.QualityLevel"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdvise::GetQualityLevel']/*"/>
|
|
<msdn-id>ms701591</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityAdvise::GetQualityLevel([Out] MF_QUALITY_LEVEL* peQualityLevel)</unmanaged>
|
|
<unmanaged-short>IMFQualityAdvise::GetQualityLevel</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdvise.DropTime(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Drops samples over a specified interval of time.</p>
|
|
</summary>
|
|
<param name="hnsAmountToDrop"><dd> <p>Amount of time to drop, in 100-nanosecond units. This value is always absolute. If the method is called multiple times, do not add the times from previous calls.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_DROPTIME_NOT_SUPPORTED</strong></dt> </dl> </td><td> <p>The object does not support this method.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Ideally the quality manager can prevent a renderer from falling behind. But if this does occur, then simply lowering quality does not guarantee the renderer will ever catch up. As a result, audio and video might fall out of sync. To correct this problem, the quality manager can call <strong>DropTime</strong> to request that the renderer drop samples quickly over a specified time interval. After that period, the renderer stops dropping samples.</p><p>This method is primarily intended for the video renderer. Dropped audio samples cause audio glitching, which is not desirable.</p><p>If a component does not support this method, it should return MF_E_DROPTIME_NOT_SUPPORTED.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdvise::DropTime']/*"/>
|
|
<msdn-id>ms697431</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityAdvise::DropTime([In] longlong hnsAmountToDrop)</unmanaged>
|
|
<unmanaged-short>IMFQualityAdvise::DropTime</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.QualityAdvise.DropMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the current drop mode.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdvise::GetDropMode']/*"/>
|
|
<msdn-id>ms702987</msdn-id>
|
|
<unmanaged>GetDropMode</unmanaged>
|
|
<unmanaged-short>GetDropMode</unmanaged-short>
|
|
<unmanaged>HRESULT IMFQualityAdvise::GetDropMode([Out] MF_QUALITY_DROP_MODE* peDropMode)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.QualityAdvise.QualityLevel">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the current quality level.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdvise::GetQualityLevel']/*"/>
|
|
<msdn-id>ms701591</msdn-id>
|
|
<unmanaged>GetQualityLevel</unmanaged>
|
|
<unmanaged-short>GetQualityLevel</unmanaged-short>
|
|
<unmanaged>HRESULT IMFQualityAdvise::GetQualityLevel([Out] MF_QUALITY_LEVEL* peQualityLevel)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.QualityAdvise2">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Enables a pipeline object to adjust its own audio or video quality, in response to quality messages.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface enables a pipeline object to respond to quality messages from the media sink. Currently, it is supported only for video decoders.</p><p>If a video decoder exposes <strong><see cref="T:SharpDX.MediaFoundation.QualityAdvise"/></strong> but not <strong><see cref="T:SharpDX.MediaFoundation.QualityAdvise2"/></strong>, the quality manager controls quality adjustments for the decoder. In this case, the quality manager responds to <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.QualityNotify"/> events from the Enhanced Video Renderer (EVR) by calling <strong><see cref="T:SharpDX.MediaFoundation.QualityAdvise"/></strong> methods on the decoder.</p><p>If the decoder exposes <strong><see cref="T:SharpDX.MediaFoundation.QualityAdvise2"/></strong>, the quality manager forwards the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.QualityNotify"/> events to the decoder and does not adjust the decoder's quality settings. The decoder should respond to these events by adjusting its own quality settings internally.</p><p>The preceding remarks apply to the default implementation of the quality manager; custom quality managers can implement other behaviors.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdvise2']/*"/>
|
|
<msdn-id>dd743249</msdn-id>
|
|
<unmanaged>IMFQualityAdvise2</unmanaged>
|
|
<unmanaged-short>IMFQualityAdvise2</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdvise2.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.QualityAdvise2"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdvise2.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.QualityAdvise2">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.QualityAdvise2"/>. (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.MediaFoundation.QualityAdvise2.NotifyQualityEvent(SharpDX.MediaFoundation.MediaEvent,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Forwards an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.QualityNotify"/> event from the media sink.</p>
|
|
</summary>
|
|
<param name="eventRef">No documentation.</param>
|
|
<param name="dwFlagsRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdvise2::NotifyQualityEvent']/*"/>
|
|
<msdn-id>dd743250</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityAdvise2::NotifyQualityEvent([In, Optional] IMFMediaEvent* pEvent,[Out] unsigned int* pdwFlags)</unmanaged>
|
|
<unmanaged-short>IMFQualityAdvise2::NotifyQualityEvent</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.QualityAdviseLimits">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Queries an object for the number of <em>quality modes</em> it supports. Quality modes are used to adjust the trade-off between quality and speed when rendering audio or video.</p><p>The default presenter for the <em>enhanced video renderer</em> (EVR) implements this interface. The EVR uses the interface to respond to quality messages from the quality manager.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdviseLimits']/*"/>
|
|
<msdn-id>dd374511</msdn-id>
|
|
<unmanaged>IMFQualityAdviseLimits</unmanaged>
|
|
<unmanaged-short>IMFQualityAdviseLimits</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdviseLimits.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.QualityAdviseLimits"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdviseLimits.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.QualityAdviseLimits">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.QualityAdviseLimits"/>. (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.MediaFoundation.QualityAdviseLimits.GetMaximumDropMode(SharpDX.MediaFoundation.QualityDropMode@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the maximum <em>drop mode</em>. A higher drop mode means that the object will, if needed, drop samples more aggressively to match the presentation clock.</p>
|
|
</summary>
|
|
<param name="eDropModeRef"><dd> <p>Receives the maximum drop mode, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.QualityDropMode"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To get the current drop mode, call the <strong><see cref="M:SharpDX.MediaFoundation.QualityAdvise.GetDropMode(SharpDX.MediaFoundation.QualityDropMode@)"/></strong> method. To set the drop mode, call the <strong><see cref="M:SharpDX.MediaFoundation.QualityAdvise.SetDropMode(SharpDX.MediaFoundation.QualityDropMode)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdviseLimits::GetMaximumDropMode']/*"/>
|
|
<msdn-id>dd374512</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityAdviseLimits::GetMaximumDropMode([Out] MF_QUALITY_DROP_MODE* peDropMode)</unmanaged>
|
|
<unmanaged-short>IMFQualityAdviseLimits::GetMaximumDropMode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityAdviseLimits.GetMinimumQualityLevel(SharpDX.MediaFoundation.QualityLevel@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the minimum quality level that is supported by the component.</p>
|
|
</summary>
|
|
<param name="eQualityLevelRef"><dd> <p>Receives the minimum quality level, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.QualityLevel"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To get the current quality level, call the <strong><see cref="M:SharpDX.MediaFoundation.QualityAdvise.GetQualityLevel(SharpDX.MediaFoundation.QualityLevel@)"/></strong> method. To set the quality level, call the <strong><see cref="M:SharpDX.MediaFoundation.QualityAdvise.SetQualityLevel(SharpDX.MediaFoundation.QualityLevel)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdviseLimits::GetMinimumQualityLevel']/*"/>
|
|
<msdn-id>dd374513</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityAdviseLimits::GetMinimumQualityLevel([Out] MF_QUALITY_LEVEL* peQualityLevel)</unmanaged>
|
|
<unmanaged-short>IMFQualityAdviseLimits::GetMinimumQualityLevel</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.QualityAdviseLimits.MaximumDropMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the maximum <em>drop mode</em>. A higher drop mode means that the object will, if needed, drop samples more aggressively to match the presentation clock.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To get the current drop mode, call the <strong><see cref="M:SharpDX.MediaFoundation.QualityAdvise.GetDropMode(SharpDX.MediaFoundation.QualityDropMode@)"/></strong> method. To set the drop mode, call the <strong><see cref="M:SharpDX.MediaFoundation.QualityAdvise.SetDropMode(SharpDX.MediaFoundation.QualityDropMode)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdviseLimits::GetMaximumDropMode']/*"/>
|
|
<msdn-id>dd374512</msdn-id>
|
|
<unmanaged>GetMaximumDropMode</unmanaged>
|
|
<unmanaged-short>GetMaximumDropMode</unmanaged-short>
|
|
<unmanaged>HRESULT IMFQualityAdviseLimits::GetMaximumDropMode([Out] MF_QUALITY_DROP_MODE* peDropMode)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.QualityAdviseLimits.MinimumQualityLevel">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the minimum quality level that is supported by the component.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To get the current quality level, call the <strong><see cref="M:SharpDX.MediaFoundation.QualityAdvise.GetQualityLevel(SharpDX.MediaFoundation.QualityLevel@)"/></strong> method. To set the quality level, call the <strong><see cref="M:SharpDX.MediaFoundation.QualityAdvise.SetQualityLevel(SharpDX.MediaFoundation.QualityLevel)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityAdviseLimits::GetMinimumQualityLevel']/*"/>
|
|
<msdn-id>dd374513</msdn-id>
|
|
<unmanaged>GetMinimumQualityLevel</unmanaged>
|
|
<unmanaged-short>GetMinimumQualityLevel</unmanaged-short>
|
|
<unmanaged>HRESULT IMFQualityAdviseLimits::GetMinimumQualityLevel([Out] MF_QUALITY_LEVEL* peQualityLevel)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.QualityManager">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called when the media processor is about to deliver an input sample to a pipeline component.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method is called for every sample passing through every pipeline component. Therefore, the method must return quickly to avoid introducing too much latency into the pipeline.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityManager']/*"/>
|
|
<msdn-id>ms703097</msdn-id>
|
|
<unmanaged>IMFQualityManager</unmanaged>
|
|
<unmanaged-short>IMFQualityManager</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityManager.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.QualityManager"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityManager.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.QualityManager">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.QualityManager"/>. (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.MediaFoundation.QualityManager.NotifyTopology(SharpDX.MediaFoundation.Topology)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called when the Media Session is about to start playing a new topology.</p>
|
|
</summary>
|
|
<param name="topologyRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface of the new topology. If this parameter is <strong><c>null</c></strong>, the quality manager should release any references to the previous topology.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>In a typical quality manager this method does the following:</p><ol> <li> <p>Enumerates the nodes in the topology.</p> </li> <li> <p>Calls <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.GetObjectW(SharpDX.ComObject@)"/></strong> to get the node's underlying object.</p> </li> <li> <p>Queries for the <strong><see cref="T:SharpDX.MediaFoundation.QualityAdvise"/></strong> interface.</p> </li> </ol><p>The quality manager can then use the <strong><see cref="T:SharpDX.MediaFoundation.QualityAdvise"/></strong> references to adjust audio-video quality as needed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityManager::NotifyTopology']/*"/>
|
|
<msdn-id>ms697409</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityManager::NotifyTopology([In] IMFTopology* pTopology)</unmanaged>
|
|
<unmanaged-short>IMFQualityManager::NotifyTopology</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityManager.NotifyPresentationClock(SharpDX.MediaFoundation.PresentationClock)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called when the Media Session selects a presentation clock.</p>
|
|
</summary>
|
|
<param name="clockRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.PresentationClock"/></strong> interface of the presentation clock. If this parameter is <strong><c>null</c></strong>, the quality manager should release any references to the presentation clock.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityManager::NotifyPresentationClock']/*"/>
|
|
<msdn-id>ms702211</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityManager::NotifyPresentationClock([In] IMFPresentationClock* pClock)</unmanaged>
|
|
<unmanaged-short>IMFQualityManager::NotifyPresentationClock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityManager.NotifyProcessInput(SharpDX.MediaFoundation.TopologyNode,System.Int32,SharpDX.MediaFoundation.Sample)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called when the media processor is about to deliver an input sample to a pipeline component.</p>
|
|
</summary>
|
|
<param name="nodeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface of the topology node that represents the pipeline component.</p> </dd></param>
|
|
<param name="lInputIndex"><dd> <p>Index of the input stream on the topology node.</p> </dd></param>
|
|
<param name="sampleRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of the input sample.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is called for every sample passing through every pipeline component. Therefore, the method must return quickly to avoid introducing too much latency into the pipeline.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityManager::NotifyProcessInput']/*"/>
|
|
<msdn-id>ms703097</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityManager::NotifyProcessInput([In] IMFTopologyNode* pNode,[In] int lInputIndex,[In] IMFSample* pSample)</unmanaged>
|
|
<unmanaged-short>IMFQualityManager::NotifyProcessInput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityManager.NotifyProcessOutput(SharpDX.MediaFoundation.TopologyNode,System.Int32,SharpDX.MediaFoundation.Sample)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called after the media processor gets an output sample from a pipeline component.</p>
|
|
</summary>
|
|
<param name="nodeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface of the topology node that represents the pipeline component.</p> </dd></param>
|
|
<param name="lOutputIndex"><dd> <p>Index of the output stream on the topology node.</p> </dd></param>
|
|
<param name="sampleRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of the output sample.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is called for every sample passing through every pipeline component. Therefore, the method must return quickly to avoid introducing too much latency into the pipeline.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityManager::NotifyProcessOutput']/*"/>
|
|
<msdn-id>ms700792</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityManager::NotifyProcessOutput([In] IMFTopologyNode* pNode,[In] int lOutputIndex,[In] IMFSample* pSample)</unmanaged>
|
|
<unmanaged-short>IMFQualityManager::NotifyProcessOutput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityManager.NotifyQualityEvent(SharpDX.ComObject,SharpDX.MediaFoundation.MediaEvent)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called when a pipeline component sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.QualityNotify"/> event.</p>
|
|
</summary>
|
|
<param name="objectRef">No documentation.</param>
|
|
<param name="eventRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityManager::NotifyQualityEvent']/*"/>
|
|
<msdn-id>ms704768</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityManager::NotifyQualityEvent([In] IUnknown* pObject,[In] IMFMediaEvent* pEvent)</unmanaged>
|
|
<unmanaged-short>IMFQualityManager::NotifyQualityEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.QualityManager.Shutdown">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called when the Media Session is shutting down.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The quality manager should release all references to the Media Session when this method is called.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFQualityManager::Shutdown']/*"/>
|
|
<msdn-id>ms703099</msdn-id>
|
|
<unmanaged>HRESULT IMFQualityManager::Shutdown()</unmanaged>
|
|
<unmanaged-short>IMFQualityManager::Shutdown</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.RateControl">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets or sets the playback rate. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Objects can expose this interface as a service. To obtain a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> with the service identifier MF_RATE_CONTROL_SERVICE. The Media Session supports this interface. Media sources and transforms support this interface if they support rate changes. Media sinks do not need to support this interface. Media sinks are notified of rate changes through the <strong><see cref="M:SharpDX.MediaFoundation.ClockStateSink.OnClockSetRate(System.Int64,System.Single)"/></strong> method.</p><p>For more information, see About Rate Control.</p><p>To discover the playback rates that an object supports, use the <strong><see cref="T:SharpDX.MediaFoundation.RateSupport"/></strong> interface</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRateControl']/*"/>
|
|
<msdn-id>ms697193</msdn-id>
|
|
<unmanaged>IMFRateControl</unmanaged>
|
|
<unmanaged-short>IMFRateControl</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RateControl.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.RateControl"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RateControl.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.RateControl">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.RateControl"/>. (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.MediaFoundation.RateControl.SetRate(System.Boolean,System.Single)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sets the playback rate. </p>
|
|
</summary>
|
|
<param name="fThin"><dd> <p> If <strong>TRUE</strong>, the media streams are thinned. Otherwise, the stream is not thinned. For media sources and demultiplexers, the object must thin the streams when this parameter is <strong>TRUE</strong>. For downstream transforms, such as decoders and multiplexers, this parameter is informative; it notifies the object that the input streams are thinned. For information, see About Rate Control. </p> </dd></param>
|
|
<param name="flRate"><dd> <p> The requested playback rate. Postive values indicate forward playback, negative values indicate reverse playback, and zero indicates scrubbing (the source delivers a single frame). </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_REVERSE_UNSUPPORTED</strong></dt> </dl> </td><td> <p> The object does not support reverse playback. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_THINNING_UNSUPPORTED</strong></dt> </dl> </td><td> <p> The object does not support thinning. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_RATE</strong></dt> </dl> </td><td> <p> The object does not support the requested playback rate. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_RATE_TRANSITION</strong></dt> </dl> </td><td> <p> The object cannot change to the new rate while in the running state. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The Media Session prevents some transitions between rate boundaries, depending on the current playback state:</p><table> <tr><th>Playback State</th><th>Forward/Reverse</th><th>Forward/Zero</th><th>Reverse/Zero</th></tr> <tr><td>Running</td><td>No</td><td>No</td><td>No</td></tr> <tr><td>Paused</td><td>No</td><td>Yes</td><td>No</td></tr> <tr><td>Stopped</td><td>Yes</td><td>Yes</td><td>Yes</td></tr> </table><p>?</p><p>If the transition is not supported, the method returns <strong>MF_E_UNSUPPORTED_RATE_TRANSITION</strong>.</p><p>When a media source completes a call to <strong>SetRate</strong>, it sends the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceRateChanged"/> event. Other pipeline components do not send this event.</p><p>If a media source switches between thinned and non-thinned playback, the streams send an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamThinMode"/> event to indicate the transition. Events from the media source are not synchronized with events from the media streams. After you receive the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceRateChanged"/> event, you can still receive samples that were queued before the stream switched to thinned or non-thinned mode. The <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamThinMode"/> event marks the exact point in the stream where the transition occurs.</p><p>When the Media Session completes a call to <strong>SetRate</strong>, it sends the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionRateChanged"/> event.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRateControl::SetRate']/*"/>
|
|
<msdn-id>ms696979</msdn-id>
|
|
<unmanaged>HRESULT IMFRateControl::SetRate([In] BOOL fThin,[In] float flRate)</unmanaged>
|
|
<unmanaged-short>IMFRateControl::SetRate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RateControl.GetRate(System.Single@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gets the current playback rate.</p>
|
|
</summary>
|
|
<param name="flRateRef"><dd> <p>Receives the current playback rate.</p> </dd></param>
|
|
<returns><dd> <p>Receives the value <strong>TRUE</strong> if the stream is currently being thinned. If the object does not support thinning, this parameter always receives the value <strong><see cref="F:SharpDX.Result.False"/></strong>. This parameter can be <strong><c>null</c></strong>. For more information, see About Rate Control.</p> </dd></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRateControl::GetRate']/*"/>
|
|
<msdn-id>ms705641</msdn-id>
|
|
<unmanaged>HRESULT IMFRateControl::GetRate([Out] BOOL* pfThin,[Out] float* pflRate)</unmanaged>
|
|
<unmanaged-short>IMFRateControl::GetRate</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.RateSupport">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Queries the range of playback rates that are supported, including reverse playback.</p><p>To get a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> with the service identifier MF_RATE_CONTROL_SERVICE.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Applications can use this interface to discover the fastest and slowest playback rates that are possible, and to query whether a given playback rate is supported. Applications obtain this interface from the Media Session. Internally, the Media Session queries the objects in the pipeline. For more information, see How to Determine Supported Rates.</p><p>To get the current playback rate and to change the playback rate, use the <strong><see cref="T:SharpDX.MediaFoundation.RateControl"/></strong> interface.</p><p>Playback rates are expressed as a ratio the normal playback rate. Reverse playback is expressed as a negative rate. Playback is either <em>thinned</em> or <em>non-thinned</em>. In thinned playback, some of the source data is skipped (typically delta frames). In non-thinned playback, all of the source data is rendered.</p><p>You might need to implement this interface if you are writing a pipeline object (media source, transform, or media sink). For more information, see Implementing Rate Control.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRateSupport']/*"/>
|
|
<msdn-id>ms701858</msdn-id>
|
|
<unmanaged>IMFRateSupport</unmanaged>
|
|
<unmanaged-short>IMFRateSupport</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RateSupport.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.RateSupport"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RateSupport.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.RateSupport">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.RateSupport"/>. (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.MediaFoundation.RateSupport.GetSlowestRate(SharpDX.MediaFoundation.RateDirection,System.Boolean,System.Single@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the slowest playback rate supported by the object.</p>
|
|
</summary>
|
|
<param name="eDirection"><dd> <p>Specifies whether to query to the slowest forward playback rate or reverse playback rate. The value is a member of the <strong><see cref="T:SharpDX.MediaFoundation.RateDirection"/></strong> enumeration.</p> </dd></param>
|
|
<param name="fThin"><dd> <p>If <strong>TRUE</strong>, the method retrieves the slowest thinned playback rate. Otherwise, the method retrieves the slowest non-thinned playback rate. For information about thinning, see About Rate Control.</p> </dd></param>
|
|
<param name="flRateRef"><dd> <p>Receives the slowest playback rate that the object supports.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_REVERSE_UNSUPPORTED</strong></dt> </dl> </td><td> <p>The object does not support reverse playback.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_THINNING_UNSUPPORTED</strong></dt> </dl> </td><td> <p>The object does not support thinning.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The value returned in <em>plfRate</em> represents a lower bound. Playback at this rate is not guaranteed. Call <strong><see cref="M:SharpDX.MediaFoundation.RateSupport.IsRateSupported(System.Boolean,System.Single,System.IntPtr)"/></strong> to check whether the boundary rate is supported. For example, a component that supports arbitrarily slow rates will return zero in <em>pflRate</em>, and applications should call <strong>IsRateSupported</strong> separately to determine whether the component supports rate 0.</p><p>If <em>eDirection</em> is <see cref="F:SharpDX.MediaFoundation.RateDirection.Reverse"/>, the method retrieves the slowest reverse playback rate. This is a negative value, assuming the object supports reverse playback.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRateSupport::GetSlowestRate']/*"/>
|
|
<msdn-id>ms704596</msdn-id>
|
|
<unmanaged>HRESULT IMFRateSupport::GetSlowestRate([In] MFRATE_DIRECTION eDirection,[In] BOOL fThin,[Out] float* pflRate)</unmanaged>
|
|
<unmanaged-short>IMFRateSupport::GetSlowestRate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RateSupport.GetFastestRate(SharpDX.MediaFoundation.RateDirection,System.Boolean,System.Single@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Gets the fastest playback rate supported by the object.</p>
|
|
</summary>
|
|
<param name="eDirection"><dd> <p>Specifies whether to query to the fastest forward playback rate or reverse playback rate. The value is a member of the <strong><see cref="T:SharpDX.MediaFoundation.RateDirection"/></strong> enumeration.</p> </dd></param>
|
|
<param name="fThin"><dd> <p>If <strong>TRUE</strong>, the method retrieves the fastest thinned playback rate. Otherwise, the method retrieves the fastest non-thinned playback rate. For information about thinning, see About Rate Control.</p> </dd></param>
|
|
<param name="flRateRef"><dd> <p>Receives the fastest playback rate that the object supports.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_REVERSE_UNSUPPORTED</strong></dt> </dl> </td><td> <p>The object does not support reverse playback.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_THINNING_UNSUPPORTED</strong></dt> </dl> </td><td> <p>The object does not support thinning.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For some formats (such as ASF), thinning means dropping all frames that are not I-frames. If a component produces stream data, such as a media source or a demultiplexer, it should pay attention to the <em>fThin</em> parameter and return MF_E_THINNING_UNSUPPORTED if it cannot thin the stream.</p><p>If the component processes or receives a stream (most transforms or media sinks), it may ignore this parameter if it does not care whether the stream is thinned. In the Media Session's implementation of rate support, if the transforms do not explicitly support reverse playback, the Media Session will attempt to playback in reverse with thinning but not without thinning. Therefore, most applications will set <em>fThin</em> to <strong>TRUE</strong> when using the Media Session for reverse playback.</p><p>If <em>eDirection</em> is <see cref="F:SharpDX.MediaFoundation.RateDirection.Reverse"/>, the method retrieves the fastest reverse playback rate. This is a negative value, assuming the object supports reverse playback.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRateSupport::GetFastestRate']/*"/>
|
|
<msdn-id>ms693505</msdn-id>
|
|
<unmanaged>HRESULT IMFRateSupport::GetFastestRate([In] MFRATE_DIRECTION eDirection,[In] BOOL fThin,[Out] float* pflRate)</unmanaged>
|
|
<unmanaged-short>IMFRateSupport::GetFastestRate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RateSupport.IsRateSupported(System.Boolean,System.Single,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Queries whether the object supports a specified playback rate.</p>
|
|
</summary>
|
|
<param name="fThin"><dd> <p>If <strong>TRUE</strong>, the method queries whether the object supports the playback rate with thinning. Otherwise, the method queries whether the object supports the playback rate without thinning. For information about thinning, see About Rate Control.</p> </dd></param>
|
|
<param name="flRate"><dd> <p>The playback rate to query.</p> </dd></param>
|
|
<param name="flNearestSupportedRateRef"><dd> <p>If the object does not support the playback rate given in <em>flRate</em>, this parameter receives the closest supported playback rate. If the method returns <see cref="F:SharpDX.Result.Ok"/>, this parameter receives the value given in <em>flRate</em>. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The object supports the specified rate.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_REVERSE_UNSUPPORTED</strong></dt> </dl> </td><td> <p>The object does not support reverse playback.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_THINNING_UNSUPPORTED</strong></dt> </dl> </td><td> <p>The object does not support thinning.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_RATE</strong></dt> </dl> </td><td> <p>The object does not support the specified rate.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRateSupport::IsRateSupported']/*"/>
|
|
<msdn-id>ms696250</msdn-id>
|
|
<unmanaged>HRESULT IMFRateSupport::IsRateSupported([In] BOOL fThin,[In] float flRate,[InOut, Optional] float* pflNearestSupportedRate)</unmanaged>
|
|
<unmanaged-short>IMFRateSupport::IsRateSupported</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ReadWriteClassFactory">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates an instance of either the sink writer or the source reader.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To get a reference to this interface, call the <strong>CoCreateInstance</strong> function. The CLSID is <strong>CLSID_MFReadWriteClassFactory</strong>. Call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> function before using the interface.</p><p>As an alternative to using this interface, you can call any of the following functions:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSinkWriterFromMediaSink(SharpDX.MediaFoundation.MediaSink,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SinkWriter@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSinkWriterFromURL(System.String,SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SinkWriter@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSourceReaderFromByteStream(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SourceReader@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSourceReaderFromMediaSource(SharpDX.MediaFoundation.MediaSource,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SourceReader@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSourceReaderFromURL(System.String,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SourceReader@)"/></strong> </li> </ul><p>Internally, these functions use the <strong><see cref="T:SharpDX.MediaFoundation.ReadWriteClassFactory"/></strong> interface.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFReadWriteClassFactory']/*"/>
|
|
<msdn-id>dd374514</msdn-id>
|
|
<unmanaged>IMFReadWriteClassFactory</unmanaged>
|
|
<unmanaged-short>IMFReadWriteClassFactory</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ReadWriteClassFactory.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ReadWriteClassFactory"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ReadWriteClassFactory.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ReadWriteClassFactory">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ReadWriteClassFactory"/>. (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.MediaFoundation.ReadWriteClassFactory.CreateInstanceFromURL(System.Guid,System.String,SharpDX.MediaFoundation.MediaAttributes,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates an instance of the sink writer or source reader, given a URL.</p>
|
|
</summary>
|
|
<param name="clsid"><dd> <p>The CLSID of the object to create.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><strong>CLSID_MFSinkWriter</strong></strong></dt> </dl> </td><td> <p>Create the sink writer. The <em>ppvObject</em> parameter receives an <strong><see cref="T:SharpDX.MediaFoundation.SinkWriter"/></strong> interface reference.</p> </td></tr> <tr><td><dl> <dt><strong><strong>CLSID_MFSourceReader</strong></strong></dt> </dl> </td><td> <p>Create the source reader. The <em>ppvObject</em> parameter receives an <strong><see cref="T:SharpDX.MediaFoundation.SourceReader"/></strong> interface reference.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="wszURLRef"><dd> <p>A null-terminated string that contains a URL. If <em>clsid</em> is CLSID_<strong>MFSinkWriter</strong>, the URL specifies the name of the output file. The sink writer creates a new file with this name. If <em>clsid</em> is <strong>CLSID_MFSourceReader</strong>, the URL specifies the input file for the source reader.</p> </dd></param>
|
|
<param name="attributesRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. You can use this parameter to configure the sink writer or source reader. For more information, see the following topics:</p> <ul> <li> Sink Writer Attributes </li> <li> Source Reader Attributes </li> </ul> <p>This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="riid"><dd> <p>The IID of the requested interface.</p> </dd></param>
|
|
<param name="vObjectOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFReadWriteClassFactory::CreateInstanceFromURL']/*"/>
|
|
<msdn-id>dd374516</msdn-id>
|
|
<unmanaged>HRESULT IMFReadWriteClassFactory::CreateInstanceFromURL([In] const GUID& clsid,[In] const wchar_t* pwszURL,[In, Optional] IMFAttributes* pAttributes,[In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
|
|
<unmanaged-short>IMFReadWriteClassFactory::CreateInstanceFromURL</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ReadWriteClassFactory.CreateInstanceFromObject(System.Guid,SharpDX.ComObject,SharpDX.MediaFoundation.MediaAttributes,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Creates an instance of the sink writer or source reader, given an <strong><see cref="T:SharpDX.ComObject"/></strong> reference. </p>
|
|
</summary>
|
|
<param name="clsid"><dd> <p>The CLSID of the object to create.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><strong>CLSID_MFSinkWriter</strong></strong></dt> </dl> </td><td> <p>Create the sink writer. The <em>ppvObject</em> parameter receives an <strong><see cref="T:SharpDX.MediaFoundation.SinkWriter"/></strong> interface reference.</p> </td></tr> <tr><td><dl> <dt><strong><strong>CLSID_MFSourceReader</strong></strong></dt> </dl> </td><td> <p>Create the source reader. The <em>ppvObject</em> parameter receives an <strong><see cref="T:SharpDX.MediaFoundation.SourceReader"/></strong> interface reference.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="unkObjectRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of an object that is used to initialize the source reader or sink writer. The method queries this reference for one of the following interfaces.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong></strong></dt> </dl> </td><td> <p>Pointer to a byte stream. </p> <p>If <em>clsid</em> is <strong>CLSID_MFSinkWriter</strong>, the sink writer writes data to this byte stream.</p> <p>If <em>clsid</em> is <strong>CLSID_MFSourceReader</strong>, this byte stream provides the source data for the source reader.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong></strong></dt> </dl> </td><td> <p>Pointer to a media sink. Applies only when <em>clsid</em> is <strong>CLSID_MFSinkWriter</strong>. </p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="T:SharpDX.MediaFoundation.MediaSource"/></strong></strong></dt> </dl> </td><td> <p>Pointer to a media source. Applies only when <em>clsid</em> is <strong>CLSID_MFSourceReader</strong>.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="attributesRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. You can use this parameter to configure the sink writer or source reader. For more information, see the following topics:</p> <ul> <li> Sink Writer Attributes </li> <li> Source Reader Attributes </li> </ul> <p>This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="riid"><dd> <p>The IID of the requested interface.</p> </dd></param>
|
|
<param name="vObjectOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFReadWriteClassFactory::CreateInstanceFromObject']/*"/>
|
|
<msdn-id>dd374515</msdn-id>
|
|
<unmanaged>HRESULT IMFReadWriteClassFactory::CreateInstanceFromObject([In] const GUID& clsid,[In] IUnknown* punkObject,[In, Optional] IMFAttributes* pAttributes,[In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
|
|
<unmanaged-short>IMFReadWriteClassFactory::CreateInstanceFromObject</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.RealTimeClient">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Notifies a pipeline object to register itself with the Multimedia Class Scheduler Service (MMCSS).</p><p>Any pipeline object that creates worker threads should implement this interface.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Media Foundation provides a mechanism for applications to associate branches in the topology with MMCSS tasks. A topology branch is defined by a source node in the topology and all of the nodes downstream from it. An application registers a topology branch with MMCSS by setting the <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueId"/></strong> attribute on the source node and then calling <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginRegisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p><p>When the application registers a topology branch with MMCSS, the Media Session queries every pipeline object in that branch for the <strong><see cref="T:SharpDX.MediaFoundation.RealTimeClient"/></strong> interface. If the object exposes the interface, the Media Session calls <strong>RegisterThreads</strong>.</p><p>When the application unregisters the topology branch, the Media Session calls <strong>UnregisterThreads</strong>.</p><p>If a pipeline object creates its own worker threads but does not implement this interface, it can cause priority inversions in the Media Foundation pipeline, because high-priority processing threads might be blocked while waiting for the component to process data on a thread with lower priority.</p><p>Pipeline objects that do not create worker threads do not need to implement this interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRealTimeClient']/*"/>
|
|
<msdn-id>aa372146</msdn-id>
|
|
<unmanaged>IMFRealTimeClient</unmanaged>
|
|
<unmanaged-short>IMFRealTimeClient</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RealTimeClient.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.RealTimeClient"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RealTimeClient.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.RealTimeClient">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.RealTimeClient"/>. (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.MediaFoundation.RealTimeClient.RegisterThreads(System.Int32,System.String)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Notifies the object to register its worker threads with the Multimedia Class Scheduler Service (MMCSS).</p>
|
|
</summary>
|
|
<param name="dwTaskIndex"><dd> <p> The MMCSS task identifier. </p> </dd></param>
|
|
<param name="wszClass"><dd> <p>The name of the MMCSS task. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> The object's worker threads should register themselves with MMCSS by calling <strong>AvSetMmThreadCharacteristics</strong>, using the task name and identifier specified in this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRealTimeClient::RegisterThreads']/*"/>
|
|
<msdn-id>aa367059</msdn-id>
|
|
<unmanaged>HRESULT IMFRealTimeClient::RegisterThreads([In] unsigned int dwTaskIndex,[In] const wchar_t* wszClass)</unmanaged>
|
|
<unmanaged-short>IMFRealTimeClient::RegisterThreads</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RealTimeClient.UnregisterThreads">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Notifies the object to unregister its worker threads from the Multimedia Class Scheduler Service (MMCSS). </p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The object's worker threads should unregister themselves from MMCSS by calling <strong>AvRevertMmThreadCharacteristics</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRealTimeClient::UnregisterThreads']/*"/>
|
|
<msdn-id>aa371717</msdn-id>
|
|
<unmanaged>HRESULT IMFRealTimeClient::UnregisterThreads()</unmanaged>
|
|
<unmanaged-short>IMFRealTimeClient::UnregisterThreads</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RealTimeClient.SetWorkQueue(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Specifies the work queue for the topology branch that contains this object.</p>
|
|
</summary>
|
|
<param name="dwWorkQueueId"><dd> <p>The identifier of the work queue, or the value <strong>MFASYNC_CALLBACK_QUEUE_UNDEFINED</strong>. See Remarks. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> An application can register a branch of the topology to use a private work queue. The Media Session notifies any pipeline object that supports <strong><see cref="T:SharpDX.MediaFoundation.RealTimeClient"/></strong> by calling <strong>SetWorkQueue</strong> with the application's work queue identifier. </p><p>When the application unregisters the topology branch, the Media Session calls <strong>SetWorkQueue</strong> again with the value <strong>MFASYNC_CALLBACK_QUEUE_UNDEFINED</strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRealTimeClient::SetWorkQueue']/*"/>
|
|
<msdn-id>aa367678</msdn-id>
|
|
<unmanaged>HRESULT IMFRealTimeClient::SetWorkQueue([In] unsigned int dwWorkQueueId)</unmanaged>
|
|
<unmanaged-short>IMFRealTimeClient::SetWorkQueue</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.RealTimeClient.WorkQueue">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Specifies the work queue for the topology branch that contains this object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> An application can register a branch of the topology to use a private work queue. The Media Session notifies any pipeline object that supports <strong><see cref="T:SharpDX.MediaFoundation.RealTimeClient"/></strong> by calling <strong>SetWorkQueue</strong> with the application's work queue identifier. </p><p>When the application unregisters the topology branch, the Media Session calls <strong>SetWorkQueue</strong> again with the value <strong>MFASYNC_CALLBACK_QUEUE_UNDEFINED</strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRealTimeClient::SetWorkQueue']/*"/>
|
|
<msdn-id>aa367678</msdn-id>
|
|
<unmanaged>SetWorkQueue</unmanaged>
|
|
<unmanaged-short>SetWorkQueue</unmanaged-short>
|
|
<unmanaged>HRESULT IMFRealTimeClient::SetWorkQueue([In] unsigned int dwWorkQueueId)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.RealTimeClientEx">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Notifies a pipeline object to register itself with the Multimedia Class Scheduler Service (MMCSS). </p><p>This interface is a replacement for the <strong><see cref="T:SharpDX.MediaFoundation.RealTimeClient"/></strong> interface.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRealTimeClientEx']/*"/>
|
|
<msdn-id>hh448047</msdn-id>
|
|
<unmanaged>IMFRealTimeClientEx</unmanaged>
|
|
<unmanaged-short>IMFRealTimeClientEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RealTimeClientEx.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.RealTimeClientEx"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RealTimeClientEx.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.RealTimeClientEx">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.RealTimeClientEx"/>. (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.MediaFoundation.RealTimeClientEx.RegisterThreadsEx(System.Int32@,System.String,System.Int32)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Notifies the object to register its worker threads with the Multimedia Class Scheduler Service (MMCSS).</p>
|
|
</summary>
|
|
<param name="dwTaskIndexRef"><dd> <p>The MMCSS task identifier. If the value is zero on input, the object should create a new MCCSS task group. See Remarks.</p> </dd></param>
|
|
<param name="wszClassName"><dd> <p>The name of the MMCSS task.</p> </dd></param>
|
|
<param name="lBasePriority"><dd> <p>The base priority of the thread.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>If the object does not create worker threads, the method should simply return <see cref="F:SharpDX.Result.Ok"/> and take no further action. </p><p>Otherwise, if the value of <code>*pdwTaskIndex</code> is zero on input, the object should perform the following steps:</p><ol> <li>A single worker thread calls <strong>AvSetMmThreadCharacteristics</strong> to create a new MMCSS task identifier. Store this value.</li> <li>Any additional worker threads call <strong>AvSetMmThreadCharacteristics</strong> using the new task identifier.</li> <li>Return the new task identifier to the caller, by setting <code>*pdwTaskIndex</code> equal to the task identifier.</li> </ol><p>If the value of <code>*pdwTaskIndex</code> is nonzero on input, the parameter contains an existing MMCSS task identifer. In that case, all worker threads of the object should register themselves for that task by calling <strong>AvSetMmThreadCharacteristics</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRealTimeClientEx::RegisterThreadsEx']/*"/>
|
|
<msdn-id>hh448048</msdn-id>
|
|
<unmanaged>HRESULT IMFRealTimeClientEx::RegisterThreadsEx([InOut] unsigned int* pdwTaskIndex,[In] const wchar_t* wszClassName,[In] int lBasePriority)</unmanaged>
|
|
<unmanaged-short>IMFRealTimeClientEx::RegisterThreadsEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RealTimeClientEx.UnregisterThreads">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Notifies the object to unregister its worker threads from the Multimedia Class Scheduler Service (MMCSS). </p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRealTimeClientEx::UnregisterThreads']/*"/>
|
|
<msdn-id>hh448050</msdn-id>
|
|
<unmanaged>HRESULT IMFRealTimeClientEx::UnregisterThreads()</unmanaged>
|
|
<unmanaged-short>IMFRealTimeClientEx::UnregisterThreads</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RealTimeClientEx.SetWorkQueueEx(System.Int32,System.Int32)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Specifies the work queue that this object should use for asynchronous work items. </p>
|
|
</summary>
|
|
<param name="dwMultithreadedWorkQueueId"><dd> <p>The work queue identifier.</p> </dd></param>
|
|
<param name="lWorkItemBasePriority"><dd> <p>The base priority for work items.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The object should use the values of <em>dwMultithreadedWorkQueueId</em> and <em>lWorkItemBasePriority</em> when it queues new work items. Use the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItem2(System.Int32,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.PutWorkItemEx2(System.Int32,System.Int32,SharpDX.MediaFoundation.AsyncResult)"/></strong> function to queue the work item.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRealTimeClientEx::SetWorkQueueEx']/*"/>
|
|
<msdn-id>hh448049</msdn-id>
|
|
<unmanaged>HRESULT IMFRealTimeClientEx::SetWorkQueueEx([In] unsigned int dwMultithreadedWorkQueueId,[In] int lWorkItemBasePriority)</unmanaged>
|
|
<unmanaged-short>IMFRealTimeClientEx::SetWorkQueueEx</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.RemoteAsyncCallback">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Used by the Microsoft Media Foundation proxy/stub DLL to marshal certain asynchronous method calls across process boundaries.</p><p>Applications do not use or implement this interface.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRemoteAsyncCallback']/*"/>
|
|
<msdn-id>bb970408</msdn-id>
|
|
<unmanaged>IMFRemoteAsyncCallback</unmanaged>
|
|
<unmanaged-short>IMFRemoteAsyncCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RemoteAsyncCallback.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.RemoteAsyncCallback"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RemoteAsyncCallback.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.RemoteAsyncCallback">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.RemoteAsyncCallback"/>. (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.MediaFoundation.RemoteAsyncCallback.Invoke(SharpDX.Result,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Used by the Microsoft Media Foundation proxy/stub DLL to marshal certain asynchronous method calls across process boundaries.</p><p>Applications do not use or implement this interface.</p>
|
|
</summary>
|
|
<param name="hr">No documentation.</param>
|
|
<param name="remoteResultRef">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='IMFRemoteAsyncCallback::Invoke']/*"/>
|
|
<msdn-id>bb970408</msdn-id>
|
|
<unmanaged>HRESULT IMFRemoteAsyncCallback::Invoke([In] HRESULT hr,[In, Optional] IUnknown* pRemoteResult)</unmanaged>
|
|
<unmanaged-short>IMFRemoteAsyncCallback::Invoke</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.RemoteDesktopPlugin">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Modifies a topology for use in a Terminal Services environment. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To use this interface, do the following:</p><ol> <li> Call <strong>GetSystemMetrics</strong> with the <strong>SM_REMOTESESSION</strong> flag. The function returns <strong>TRUE</strong> if the calling process is associated with a Terminal Services client session. </li> <li> If <strong>GetSystemMetrics</strong> returns <strong>TRUE</strong>, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateRemoteDesktopPlugin(SharpDX.MediaFoundation.RemoteDesktopPlugin@)"/></strong>. This function returns a reference to the <strong><see cref="T:SharpDX.MediaFoundation.RemoteDesktopPlugin"/></strong> interface. </li> <li> Call <strong>UpdateTopology</strong> with a reference to the topology. </li> </ol><p>The application must call <strong>UpdateTopology</strong> before calling <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.SetTopology(System.Int32,SharpDX.MediaFoundation.Topology)"/></strong> on the Media Session.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRemoteDesktopPlugin']/*"/>
|
|
<msdn-id>ms698979</msdn-id>
|
|
<unmanaged>IMFRemoteDesktopPlugin</unmanaged>
|
|
<unmanaged-short>IMFRemoteDesktopPlugin</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RemoteDesktopPlugin.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.RemoteDesktopPlugin"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RemoteDesktopPlugin.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.RemoteDesktopPlugin">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.RemoteDesktopPlugin"/>. (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.MediaFoundation.RemoteDesktopPlugin.UpdateTopology(SharpDX.MediaFoundation.Topology)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Modifies a topology for use in a Terminal Services environment.</p>
|
|
</summary>
|
|
<param name="topologyRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface of the topology.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the application is running in a Terminal Services client session, call this method before calling <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.SetTopology(System.Int32,SharpDX.MediaFoundation.Topology)"/></strong> on the Media Session.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRemoteDesktopPlugin::UpdateTopology']/*"/>
|
|
<msdn-id>ms699001</msdn-id>
|
|
<unmanaged>HRESULT IMFRemoteDesktopPlugin::UpdateTopology([In] IMFTopology* pTopology)</unmanaged>
|
|
<unmanaged-short>IMFRemoteDesktopPlugin::UpdateTopology</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.RemoteProxy">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves a reference to the remote object for which this object is a proxy.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRemoteProxy']/*"/>
|
|
<msdn-id>bb970370</msdn-id>
|
|
<unmanaged>IMFRemoteProxy</unmanaged>
|
|
<unmanaged-short>IMFRemoteProxy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RemoteProxy.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.RemoteProxy"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RemoteProxy.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.RemoteProxy">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.RemoteProxy"/>. (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.MediaFoundation.RemoteProxy.GetRemoteObject(System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves a reference to the remote object for which this object is a proxy.</p>
|
|
</summary>
|
|
<param name="riid"><dd> <p>Interface identifier (IID) of the requested interface.</p> </dd></param>
|
|
<param name="vOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFRemoteProxy::GetRemoteObject']/*"/>
|
|
<msdn-id>bb970370</msdn-id>
|
|
<unmanaged>HRESULT IMFRemoteProxy::GetRemoteObject([In] const GUID& riid,[Out] void** ppv)</unmanaged>
|
|
<unmanaged-short>IMFRemoteProxy::GetRemoteObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.RemoteProxy.GetRemoteHost(System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="riid">No documentation.</param>
|
|
<param name="vOut">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='IMFRemoteProxy::GetRemoteHost']/*"/>
|
|
<unmanaged>HRESULT IMFRemoteProxy::GetRemoteHost([In] const GUID& riid,[Out] void** ppv)</unmanaged>
|
|
<unmanaged-short>IMFRemoteProxy::GetRemoteHost</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SAMIStyle">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Sets and retrieves Synchronized Accessible Media Interchange (SAMI) styles on the SAMI Media Source. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> To get a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <strong>MF_SAMI_SERVICE</strong>. Call <strong>GetService</strong> either directly on the SAMI media source, or on the Media Session (if you are using the SAMI source with the Media Session).</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSAMIStyle']/*"/>
|
|
<msdn-id>aa473825</msdn-id>
|
|
<unmanaged>IMFSAMIStyle</unmanaged>
|
|
<unmanaged-short>IMFSAMIStyle</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SAMIStyle.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SAMIStyle"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SAMIStyle.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SAMIStyle">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SAMIStyle"/>. (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.MediaFoundation.SAMIStyle.GetStyleCount(System.Int32@)">
|
|
<summary>
|
|
<p>Gets the total number of SAMI styles supported by the media source.</p> <see cref="T:SharpDX.Result"/> GetStyleCount (DWORD * pdwCount);<p></p>Parameters <p> pdwCount </p> <p>[out] Pointer to a DWORD that receives the number of SAMI styles. This parameter cannot be <c>null</c>.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>E_POINTER</p> </td> <td> <p><c>null</c> was passed in pdwCount.</p> </td> </tr></table> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFSAMIStyle Interface
|
|
</summary>
|
|
<param name="dwCountRef">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='IMFSAMIStyle::GetStyleCount']/*"/>
|
|
<msdn-id>aa473802</msdn-id>
|
|
<unmanaged>HRESULT IMFSAMIStyle::GetStyleCount([Out] unsigned int* pdwCount)</unmanaged>
|
|
<unmanaged-short>IMFSAMIStyle::GetStyleCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SAMIStyle.GetStyles(SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets a list of the style names defined in the SAMI file. </p>
|
|
</summary>
|
|
<param name="propVarStyleArrayRef"><dd> <p>Pointer to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that receives an array of null-terminated wide-character strings. The <strong><see cref="T:SharpDX.Win32.Variant"/></strong> type is VT_VECTOR | VT_LPWSTR. The caller must clear the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> by calling <strong>PropVariantClear</strong>.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSAMIStyle::GetStyles']/*"/>
|
|
<msdn-id>bb970547</msdn-id>
|
|
<unmanaged>HRESULT IMFSAMIStyle::GetStyles([Out] PROPVARIANT* pPropVarStyleArray)</unmanaged>
|
|
<unmanaged-short>IMFSAMIStyle::GetStyles</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SAMIStyle.SetSelectedStyle(System.String)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Sets the current style on the SAMI media source.</p>
|
|
</summary>
|
|
<param name="wszStyleRef"><dd> <p>Pointer to a null-terminated string containing the name of the style. To clear the current style, pass an empty string (""). To get the list of style names, call <strong><see cref="M:SharpDX.MediaFoundation.SAMIStyle.GetStyles(SharpDX.Win32.Variant@)"/></strong>.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSAMIStyle::SetSelectedStyle']/*"/>
|
|
<msdn-id>bb970574</msdn-id>
|
|
<unmanaged>HRESULT IMFSAMIStyle::SetSelectedStyle([In] const wchar_t* pwszStyle)</unmanaged>
|
|
<unmanaged-short>IMFSAMIStyle::SetSelectedStyle</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SAMIStyle.GetSelectedStyle(System.IntPtr)">
|
|
<summary>
|
|
<p>Gets the currently selected SAMI style on the media source.</p> <see cref="T:SharpDX.Result"/> GetSelectedStyle (LPWSTR * ppwszStyle);<p></p>Parameters <p> pwszStyle </p> <p>[out] Pointer to a null-terminated string that receives the name of the style. Value of "" indicates that no style has been set. This parameter cannot be <c>null</c>.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>E_POINTER</p> </td> <td> <p><c>null</c> was passed in ppwszStyle.</p> </td> </tr></table> <p>To avoid memory leaks, the caller must de-allocate the returned string by calling CoTaskMemFree.</p> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFSAMIStyle Interface
|
|
</summary>
|
|
<param name="wszStyleOut">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='IMFSAMIStyle::GetSelectedStyle']/*"/>
|
|
<msdn-id>aa473721</msdn-id>
|
|
<unmanaged>HRESULT IMFSAMIStyle::GetSelectedStyle([Out] wchar_t** ppwszStyle)</unmanaged>
|
|
<unmanaged-short>IMFSAMIStyle::GetSelectedStyle</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.SAMIStyle.StyleCount">
|
|
<summary>
|
|
<p>Gets the total number of SAMI styles supported by the media source.</p> <see cref="T:SharpDX.Result"/> GetStyleCount (DWORD * pdwCount);<p></p>Parameters <p> pdwCount </p> <p>[out] Pointer to a DWORD that receives the number of SAMI styles. This parameter cannot be <c>null</c>.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>E_POINTER</p> </td> <td> <p><c>null</c> was passed in pdwCount.</p> </td> </tr></table> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFSAMIStyle Interface
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSAMIStyle::GetStyleCount']/*"/>
|
|
<msdn-id>aa473802</msdn-id>
|
|
<unmanaged>GetStyleCount</unmanaged>
|
|
<unmanaged-short>GetStyleCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSAMIStyle::GetStyleCount([Out] unsigned int* pdwCount)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.SAMIStyle.Styles">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets a list of the style names defined in the SAMI file. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSAMIStyle::GetStyles']/*"/>
|
|
<msdn-id>bb970547</msdn-id>
|
|
<unmanaged>GetStyles</unmanaged>
|
|
<unmanaged-short>GetStyles</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSAMIStyle::GetStyles([Out] PROPVARIANT* pPropVarStyleArray)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Sample">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Represents a media sample, which is a container object for media data. For video, a sample typically contains one video frame. For audio data, a sample typically contains multiple audio samples, rather than a single sample of audio.</p><p>A media sample contains zero or more buffers. Each buffer manages a block of memory, and is represented by the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface. A sample can have multiple buffers. The buffers are kept in an ordered list and accessed by index value. It is also valid to have an empty sample with no buffers.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To create a new media sample, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSample(SharpDX.MediaFoundation.Sample@)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample']/*"/>
|
|
<msdn-id>ms702192</msdn-id>
|
|
<unmanaged>IMFSample</unmanaged>
|
|
<unmanaged-short>IMFSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Sample"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Sample">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Sample"/>. (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.MediaFoundation.Sample.GetSampleFlags(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves flags associated with the sample.</p><p>Currently no flags are defined. Instead, metadata for samples is defined using attributes. To get attibutes from a sample, use the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface, which <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> inherits. For a list of sample attributes, see Sample Attributes.</p>
|
|
</summary>
|
|
<param name="dwSampleFlagsRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetSampleFlags']/*"/>
|
|
<msdn-id>ms701587</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::GetSampleFlags([Out] unsigned int* pdwSampleFlags)</unmanaged>
|
|
<unmanaged-short>IMFSample::GetSampleFlags</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.SetSampleFlags(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets flags associated with the sample.</p><p>Currently no flags are defined. Instead, metadata for samples is defined using attributes. To set attibutes on a sample, use the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface, which <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> inherits. For a list of sample attributes, see Sample Attributes.</p>
|
|
</summary>
|
|
<param name="dwSampleFlags">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::SetSampleFlags']/*"/>
|
|
<msdn-id>ms696207</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::SetSampleFlags([In] unsigned int dwSampleFlags)</unmanaged>
|
|
<unmanaged-short>IMFSample::SetSampleFlags</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.GetSampleTime(System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the presentation time of the sample.</p>
|
|
</summary>
|
|
<param name="hnsSampleTimeRef"><dd> <p>Receives the presentation time, in 100-nanosecond units.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_SAMPLE_TIMESTAMP</strong></dt> </dl> </td><td> <p>The sample does not have a presentation time.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetSampleTime']/*"/>
|
|
<msdn-id>ms705645</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::GetSampleTime([Out] longlong* phnsSampleTime)</unmanaged>
|
|
<unmanaged-short>IMFSample::GetSampleTime</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.SetSampleTime(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the presentation time of the sample.</p>
|
|
</summary>
|
|
<param name="hnsSampleTime"><dd> <p>The presentation time, in 100-nanosecond units.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Some pipeline components require samples that have time stamps. Generally the component that generates the data for the sample also sets the time stamp. The Media Session might modify the time stamps.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::SetSampleTime']/*"/>
|
|
<msdn-id>ms697282</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::SetSampleTime([In] longlong hnsSampleTime)</unmanaged>
|
|
<unmanaged-short>IMFSample::SetSampleTime</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.GetSampleDuration(System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the duration of the sample.</p>
|
|
</summary>
|
|
<param name="hnsSampleDurationRef"><dd> <p>Receives the duration, in 100-nanosecond units.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_SAMPLE_DURATION</strong></dt> </dl> </td><td> <p>The sample does not have a specified duration.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the sample contains more than one buffer, the duration includes the data from all of the buffers.</p><p>If the retrieved duration is zero, or if the method returns <strong>MF_E_NO_SAMPLE_DURATION</strong>, the duration is unknown. In that case, it might be possible to calculate the duration from the media type?for example, by using the video frame rate or the audio sampling rate.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetSampleDuration']/*"/>
|
|
<msdn-id>ms703056</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::GetSampleDuration([Out] longlong* phnsSampleDuration)</unmanaged>
|
|
<unmanaged-short>IMFSample::GetSampleDuration</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.SetSampleDuration(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the duration of the sample.</p>
|
|
</summary>
|
|
<param name="hnsSampleDuration"><dd> <p>Duration of the sample, in 100-nanosecond units.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This method succeeds if the duration is negative, although negative durations are probably not valid for most types of data. It is the responsibility of the object that consumes the sample to validate the duration.</p><p>The duration can also be zero. This might be valid for some types of data. For example, the sample might contain stream metadata with no buffers.</p><p>Until this method is called, the <strong><see cref="M:SharpDX.MediaFoundation.Sample.GetSampleDuration(System.Int64@)"/></strong> method returns <strong>MF_E_NO_SAMPLE_DURATION</strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::SetSampleDuration']/*"/>
|
|
<msdn-id>ms705626</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::SetSampleDuration([In] longlong hnsSampleDuration)</unmanaged>
|
|
<unmanaged-short>IMFSample::SetSampleDuration</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.GetBufferCount(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of buffers in the sample.</p>
|
|
</summary>
|
|
<param name="dwBufferCountRef"><dd> <p>Receives the number of buffers in the sample. A sample might contain zero buffers.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetBufferCount']/*"/>
|
|
<msdn-id>ms705655</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::GetBufferCount([Out] unsigned int* pdwBufferCount)</unmanaged>
|
|
<unmanaged-short>IMFSample::GetBufferCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.GetBufferByIndex(System.Int32,SharpDX.MediaFoundation.MediaBuffer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets a buffer from the sample, by index.</p><p> </p><p><strong>Note</strong>??In most cases, it is safer to use the <strong><see cref="M:SharpDX.MediaFoundation.Sample.ConvertToContiguousBuffer(SharpDX.MediaFoundation.MediaBuffer@)"/></strong> method. If the sample contains more than one buffer, the <strong>ConvertToContiguousBuffer</strong> method replaces them with a single buffer, copies the original data into that buffer, and returns the new buffer to the caller. The copy operation occurs at most once. On subsequent calls, no data is copied.</p>
|
|
</summary>
|
|
<param name="dwIndex">No documentation.</param>
|
|
<param name="bufferOut">No documentation.</param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><strong><c>null</c></strong> reference argument, or the index is out of range. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>A sample might contain more than one buffer. Use the <strong>GetBufferByIndex</strong> method to enumerate the individual buffers.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetBufferByIndex']/*"/>
|
|
<msdn-id>ms697014</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::GetBufferByIndex([In] unsigned int dwIndex,[Out] IMFMediaBuffer** ppBuffer)</unmanaged>
|
|
<unmanaged-short>IMFSample::GetBufferByIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.ConvertToContiguousBuffer(SharpDX.MediaFoundation.MediaBuffer@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Converts a sample with multiple buffers into a sample with a single buffer. </p>
|
|
</summary>
|
|
<param name="bufferOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_UNEXPECTED</strong></dt> </dl> </td><td> <p>The sample does not contain any buffers.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the sample contains more than one buffer, this method copies the data from the original buffers into a new buffer, and replaces the original buffer list with the new buffer. The new buffer is returned in the <em>ppBuffer</em> parameter.</p><p> If the sample contains a single buffer, this method returns a reference to the original buffer. In typical use, most samples do not contain multiple buffers.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::ConvertToContiguousBuffer']/*"/>
|
|
<msdn-id>ms698917</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::ConvertToContiguousBuffer([Out] IMFMediaBuffer** ppBuffer)</unmanaged>
|
|
<unmanaged-short>IMFSample::ConvertToContiguousBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.AddBuffer(SharpDX.MediaFoundation.MediaBuffer)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Adds a buffer to the end of the list of buffers in the sample. </p>
|
|
</summary>
|
|
<param name="bufferRef"><dd> <p>Pointer to the buffer's <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><c>null</c> reference argument.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For uncompressed video data, each buffer should contain a single video frame, and samples should not contain multiple frames. In general, storing multiple buffers in a sample is discouraged.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::AddBuffer']/*"/>
|
|
<msdn-id>ms697465</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::AddBuffer([In] IMFMediaBuffer* pBuffer)</unmanaged>
|
|
<unmanaged-short>IMFSample::AddBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.RemoveBufferByIndex(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Removes a buffer at a specified index from the sample.</p>
|
|
</summary>
|
|
<param name="dwIndex"><dd> <p>Index of the buffer. To find the number of buffers in the sample, call <strong><see cref="M:SharpDX.MediaFoundation.Sample.GetBufferCount(System.Int32@)"/></strong>. Buffers are indexed from zero.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::RemoveBufferByIndex']/*"/>
|
|
<msdn-id>ms705646</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::RemoveBufferByIndex([In] unsigned int dwIndex)</unmanaged>
|
|
<unmanaged-short>IMFSample::RemoveBufferByIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.RemoveAllBuffers">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Removes all of the buffers from the sample.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::RemoveAllBuffers']/*"/>
|
|
<msdn-id>ms703108</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::RemoveAllBuffers()</unmanaged>
|
|
<unmanaged-short>IMFSample::RemoveAllBuffers</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.GetTotalLength(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the total length of the valid data in all of the buffers in the sample. The length is calculated as the sum of the values retrieved by the <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetCurrentLength(System.Int32@)"/></strong> method.</p>
|
|
</summary>
|
|
<param name="cbTotalLengthRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetTotalLength']/*"/>
|
|
<msdn-id>ms704584</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::GetTotalLength([Out] unsigned int* pcbTotalLength)</unmanaged>
|
|
<unmanaged-short>IMFSample::GetTotalLength</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Sample.CopyToBuffer(SharpDX.MediaFoundation.MediaBuffer)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Copies the sample data to a buffer. This method concatenates the valid data from all of the buffers of the sample, in order.</p>
|
|
</summary>
|
|
<param name="bufferRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaBuffer"/></strong> interface of the destination buffer. The buffer must be large enough to hold the valid data in the sample. To get the size of the data in the sample, call <strong><see cref="M:SharpDX.MediaFoundation.Sample.GetTotalLength(System.Int32@)"/></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><c>null</c> reference argument.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BUFFERTOOSMALL</strong></dt> </dl> </td><td> <p>The buffer is not large enough to contain the data.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::CopyToBuffer']/*"/>
|
|
<msdn-id>ms703119</msdn-id>
|
|
<unmanaged>HRESULT IMFSample::CopyToBuffer([In] IMFMediaBuffer* pBuffer)</unmanaged>
|
|
<unmanaged-short>IMFSample::CopyToBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Sample.SampleFlags">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves flags associated with the sample.</p><p>Currently no flags are defined. Instead, metadata for samples is defined using attributes. To get attibutes from a sample, use the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface, which <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> inherits. For a list of sample attributes, see Sample Attributes.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetSampleFlags']/*"/>
|
|
<msdn-id>ms701587</msdn-id>
|
|
<unmanaged>GetSampleFlags</unmanaged>
|
|
<unmanaged-short>GetSampleFlags</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSample::GetSampleFlags([Out] unsigned int* pdwSampleFlags)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Sample.SampleTime">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the presentation time of the sample.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetSampleTime']/*"/>
|
|
<msdn-id>ms705645</msdn-id>
|
|
<unmanaged>GetSampleTime</unmanaged>
|
|
<unmanaged-short>GetSampleTime</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSample::GetSampleTime([Out] longlong* phnsSampleTime)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Sample.SampleDuration">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the duration of the sample.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the sample contains more than one buffer, the duration includes the data from all of the buffers.</p><p>If the retrieved duration is zero, or if the method returns <strong>MF_E_NO_SAMPLE_DURATION</strong>, the duration is unknown. In that case, it might be possible to calculate the duration from the media type?for example, by using the video frame rate or the audio sampling rate.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetSampleDuration']/*"/>
|
|
<msdn-id>ms703056</msdn-id>
|
|
<unmanaged>GetSampleDuration</unmanaged>
|
|
<unmanaged-short>GetSampleDuration</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSample::GetSampleDuration([Out] longlong* phnsSampleDuration)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Sample.BufferCount">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the number of buffers in the sample.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetBufferCount']/*"/>
|
|
<msdn-id>ms705655</msdn-id>
|
|
<unmanaged>GetBufferCount</unmanaged>
|
|
<unmanaged-short>GetBufferCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSample::GetBufferCount([Out] unsigned int* pdwBufferCount)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Sample.TotalLength">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the total length of the valid data in all of the buffers in the sample. The length is calculated as the sum of the values retrieved by the <strong><see cref="M:SharpDX.MediaFoundation.MediaBuffer.GetCurrentLength(System.Int32@)"/></strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSample::GetTotalLength']/*"/>
|
|
<msdn-id>ms704584</msdn-id>
|
|
<unmanaged>GetTotalLength</unmanaged>
|
|
<unmanaged-short>GetTotalLength</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSample::GetTotalLength([Out] unsigned int* pcbTotalLength)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Callback interface to get media data from the sample-grabber sink. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The sample-grabber sink enables an application to get data from the Media Foundation pipeline without implementing a custom media sink. To use the sample-grabber sink, the application must perform the following steps:</p><ol> <li> <p>Implement the <strong><see cref="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback"/></strong> interface.</p> </li> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSampleGrabberSinkActivate(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.SampleGrabberSinkCallback,SharpDX.MediaFoundation.Activate@)"/></strong>, passing in the <strong><see cref="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback"/></strong> interface reference. This function returns an <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> object.</p> </li> <li> <p>Create a topology that includes an output node with the sink's <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> object.</p> </li> <li> <p>Pass this topology to the Media Session.</p> </li> </ol><p>During playback, the sample-grabber sink calls methods on the application's callback.</p><p>You cannot use the sample-grabber sink to get protected content.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleGrabberSinkCallback']/*"/>
|
|
<msdn-id>ms697548</msdn-id>
|
|
<unmanaged>IMFSampleGrabberSinkCallback</unmanaged>
|
|
<unmanaged-short>IMFSampleGrabberSinkCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleGrabberSinkCallback.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleGrabberSinkCallback.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SampleGrabberSinkCallback">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback"/>. (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.MediaFoundation.SampleGrabberSinkCallback.OnSetPresentationClock(SharpDX.MediaFoundation.PresentationClock)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called when the presentation clock is set on the sample-grabber sink.</p>
|
|
</summary>
|
|
<param name="presentationClockRef"><dd> <p>Pointer to the presentation clock's <strong><see cref="T:SharpDX.MediaFoundation.PresentationClock"/></strong> interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method should return quickly, or it might interfere with playback. Do not block the thread, wait on events, or perform other lengthy operations inside this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleGrabberSinkCallback::OnSetPresentationClock']/*"/>
|
|
<msdn-id>bb970506</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleGrabberSinkCallback::OnSetPresentationClock([In] IMFPresentationClock* pPresentationClock)</unmanaged>
|
|
<unmanaged-short>IMFSampleGrabberSinkCallback::OnSetPresentationClock</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleGrabberSinkCallback.OnProcessSample(System.Guid,System.Int32,System.Int64,System.Int64,System.Byte[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called when the sample-grabber sink receives a new media sample.</p>
|
|
</summary>
|
|
<param name="guidMajorMediaType"><dd> <p>The major type that specifies the format of the data. For a list of possible values, see Major Media Types. </p> </dd></param>
|
|
<param name="dwSampleFlags"><dd> <p> Reserved. </p> </dd></param>
|
|
<param name="llSampleTime"><dd> <p>The presentation time for this sample, in 100-nanosecond units. If the sample does not have a presentation time, the value of this parameter is <strong>_I64_MAX</strong>.</p> </dd></param>
|
|
<param name="llSampleDuration"><dd> <p>The duration of the sample, in 100-nanosecond units. If the sample does not have a duration, the value of this parameter is <strong>_I64_MAX</strong>.</p> </dd></param>
|
|
<param name="sampleBufferRef"><dd> <p> A reference to a buffer that contains the sample data. </p> </dd></param>
|
|
<param name="dwSampleSize"><dd> <p> Size of the <em>pSampleBuffer</em> buffer, in bytes. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>If you use the sample-grabber sink in a playback topology, this method should return quickly, or it might interfere with playback. Do not block the thread, wait on events, or perform other lengthy operations inside this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleGrabberSinkCallback::OnProcessSample']/*"/>
|
|
<msdn-id>bb970326</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleGrabberSinkCallback::OnProcessSample([In] const GUID& guidMajorMediaType,[In] unsigned int dwSampleFlags,[In] longlong llSampleTime,[In] longlong llSampleDuration,[In, Buffer] const unsigned char* pSampleBuffer,[In] unsigned int dwSampleSize)</unmanaged>
|
|
<unmanaged-short>IMFSampleGrabberSinkCallback::OnProcessSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleGrabberSinkCallback.OnShutdown">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called when the sample-grabber sink is shut down.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is called when the sink's <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.Shutdown"/></strong> method is called.</p><p>The <strong>OnShutdown</strong> method should return quickly, or it might interfere with playback. Do not block the thread, wait on events, or perform other lengthy operations inside this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleGrabberSinkCallback::OnShutdown']/*"/>
|
|
<msdn-id>ms703093</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleGrabberSinkCallback::OnShutdown()</unmanaged>
|
|
<unmanaged-short>IMFSampleGrabberSinkCallback::OnShutdown</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback2">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Extends the <strong><see cref="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback"/></strong> interface.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This callback interface is used with the sample-grabber sink. It extends the <strong><see cref="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback"/></strong> interface by adding the <strong>OnProcessSampleEx</strong> method, which supersedes the <strong><see cref="M:SharpDX.MediaFoundation.SampleGrabberSinkCallback.OnProcessSample(System.Guid,System.Int32,System.Int64,System.Int64,System.Byte[],System.Int32)"/></strong> method.</p><p> The <strong>OnProcessSampleEx</strong> method adds a parameter that contains the attributes for the media sample. You can use the attributes to get information about the sample, such as field dominance and telecine flags. </p><p>To use this interface, do the following: </p><ol> <li>Implement a callback object that exposes the interface.</li> <li>Create the sample-grabber sink by calling the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSampleGrabberSinkActivate(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.SampleGrabberSinkCallback,SharpDX.MediaFoundation.Activate@)"/></strong> function. Pass the callback reference in the <em>pIMFSampleGrabberSinkCallback</em> parameter.</li> <li>The sample-grabber sink will call <strong>QueryInterface</strong> on the callback object.</li> <li>If the callback object exposes the <strong><see cref="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback2"/></strong> interface, the sample-grabber sink will use the <strong>OnProcessSampleEx</strong> callback method. Otherwise, the sample-grabber sink will use the older <strong>OnProcessSample</strong> callback method.</li> </ol>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleGrabberSinkCallback2']/*"/>
|
|
<msdn-id>dd374517</msdn-id>
|
|
<unmanaged>IMFSampleGrabberSinkCallback2</unmanaged>
|
|
<unmanaged-short>IMFSampleGrabberSinkCallback2</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleGrabberSinkCallback2.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback2"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleGrabberSinkCallback2.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SampleGrabberSinkCallback2">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SampleGrabberSinkCallback2"/>. (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.MediaFoundation.SampleGrabberSinkCallback2.OnProcessSampleEx(System.Guid,System.Int32,System.Int64,System.Int64,System.Byte[],System.Int32,SharpDX.MediaFoundation.MediaAttributes)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Called when the sample-grabber sink receives a new media sample.</p>
|
|
</summary>
|
|
<param name="guidMajorMediaType"><dd> <p>The major type <see cref="T:System.Guid"/> that specifies the format of the data. For a list of possible values, see Major Media Types. </p> </dd></param>
|
|
<param name="dwSampleFlags"><dd> <p>Sample flags. The sample-grabber sink gets the value of this parameter by calling the <strong><see cref="M:SharpDX.MediaFoundation.Sample.GetSampleFlags(System.Int32@)"/></strong> method of the media sample.</p> </dd></param>
|
|
<param name="llSampleTime"><dd> <p>The presentation time for this sample, in 100-nanosecond units. If the sample does not have a presentation time, the value of this parameter is <strong>_I64_MAX</strong></p> </dd></param>
|
|
<param name="llSampleDuration"><dd> <p>The duration of the sample, in 100-nanosecond units. If the sample does not have a duration, the value of this parameter is <strong>_I64_MAX</strong>.</p> </dd></param>
|
|
<param name="sampleBufferRef"><dd> <p>A reference to a buffer that contains the sample data.</p> </dd></param>
|
|
<param name="dwSampleSize"><dd> <p>The size, in bytes, of the <em>pSampleBuffer</em> buffer.</p> </dd></param>
|
|
<param name="attributesRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. Use this interface to get the attributes for this sample (if any). For a list of sample attributes, see Sample Attributes.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>If you use the sample-grabber sink in a playback topology, this method should return quickly, or it might interfere with playback. Do not block the thread, wait on events, or perform other lengthy operations inside this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleGrabberSinkCallback2::OnProcessSampleEx']/*"/>
|
|
<msdn-id>dd374518</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleGrabberSinkCallback2::OnProcessSampleEx([In] const GUID& guidMajorMediaType,[In] unsigned int dwSampleFlags,[In] longlong llSampleTime,[In] longlong llSampleDuration,[In, Buffer] const unsigned char* pSampleBuffer,[In] unsigned int dwSampleSize,[In] IMFAttributes* pAttributes)</unmanaged>
|
|
<unmanaged-short>IMFSampleGrabberSinkCallback2::OnProcessSampleEx</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SampleOutputStream">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Begins an asynchronous request to write a media sample to the stream.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>When the sample has been written to the stream, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the caller should call <strong><see cref="M:SharpDX.MediaFoundation.SampleOutputStream.EndWriteSample(SharpDX.MediaFoundation.AsyncResult)"/></strong> to complete the asynchronous request. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleOutputStream']/*"/>
|
|
<msdn-id>hh448052</msdn-id>
|
|
<unmanaged>IMFSampleOutputStream</unmanaged>
|
|
<unmanaged-short>IMFSampleOutputStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleOutputStream.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SampleOutputStream"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleOutputStream.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SampleOutputStream">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SampleOutputStream"/>. (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.MediaFoundation.SampleOutputStream.BeginWriteSample(SharpDX.MediaFoundation.Sample,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Begins an asynchronous request to write a media sample to the stream.</p>
|
|
</summary>
|
|
<param name="sampleRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of the sample.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface.</p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>When the sample has been written to the stream, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the caller should call <strong><see cref="M:SharpDX.MediaFoundation.SampleOutputStream.EndWriteSample(SharpDX.MediaFoundation.AsyncResult)"/></strong> to complete the asynchronous request. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleOutputStream::BeginWriteSample']/*"/>
|
|
<msdn-id>hh448052</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleOutputStream::BeginWriteSample([In, Optional] IMFSample* pSample,[In, Optional] IMFAsyncCallback* pCallback,[In, Optional] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFSampleOutputStream::BeginWriteSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleOutputStream.EndWriteSample(SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Completes an asynchronous request to write a media sample to the stream.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call this method when the <strong><see cref="M:SharpDX.MediaFoundation.SampleOutputStream.BeginWriteSample(SharpDX.MediaFoundation.Sample,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleOutputStream::EndWriteSample']/*"/>
|
|
<msdn-id>hh448053</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleOutputStream::EndWriteSample([In, Optional] IMFAsyncResult* pResult)</unmanaged>
|
|
<unmanaged-short>IMFSampleOutputStream::EndWriteSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleOutputStream.Close">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p>These are the API elements for use in desktop apps that are new for Windows?8 Consumer Preview:</p><p> </p><ul> <li>Win32/{{COM}}</li> <li>Windows</li> </ul><p>For a list of technologies that are new for desktop apps, see Windows 8 Technologies.</p><p>For info about the APIs that can be used in Metro style apps, see APIs for Metro style apps.</p>
|
|
</summary>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleOutputStream::Close']/*"/>
|
|
<msdn-id>hh405363</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleOutputStream::Close()</unmanaged>
|
|
<unmanaged-short>IMFSampleOutputStream::Close</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SampleProtection">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves initialization information for sample protection from the upstream component.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method must be implemented by the upstream component. The method fails if the component does not support the requested sample protection version. Downstream components do not implement this method and should return E_NOTIMPL.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleProtection']/*"/>
|
|
<msdn-id>ms693577</msdn-id>
|
|
<unmanaged>IMFSampleProtection</unmanaged>
|
|
<unmanaged-short>IMFSampleProtection</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleProtection.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SampleProtection"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleProtection.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SampleProtection">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SampleProtection"/>. (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.MediaFoundation.SampleProtection.GetInputProtectionVersion(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the version of sample protection that the component implements on input.</p>
|
|
</summary>
|
|
<param name="dwVersionRef"><dd> <p>Receives a member of the <strong><see cref="T:SharpDX.MediaFoundation.SampleProtectionVersion"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleProtection::GetInputProtectionVersion']/*"/>
|
|
<msdn-id>bb970365</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleProtection::GetInputProtectionVersion([Out] unsigned int* pdwVersion)</unmanaged>
|
|
<unmanaged-short>IMFSampleProtection::GetInputProtectionVersion</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleProtection.GetOutputProtectionVersion(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the version of sample protection that the component implements on output.</p>
|
|
</summary>
|
|
<param name="dwVersionRef"><dd> <p>Receives a member of the <strong><see cref="T:SharpDX.MediaFoundation.SampleProtectionVersion"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleProtection::GetOutputProtectionVersion']/*"/>
|
|
<msdn-id>bb970415</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleProtection::GetOutputProtectionVersion([Out] unsigned int* pdwVersion)</unmanaged>
|
|
<unmanaged-short>IMFSampleProtection::GetOutputProtectionVersion</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleProtection.GetProtectionCertificate(System.Int32,System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the sample protection certificate.</p>
|
|
</summary>
|
|
<param name="dwVersion"><dd> <p>Specifies the version number of the sample protection scheme for which to receive a certificate. The version number is specified as a <strong><see cref="T:SharpDX.MediaFoundation.SampleProtectionVersion"/></strong> enumeration value.</p> </dd></param>
|
|
<param name="certOut"><dd> <p>Receives a reference to a buffer containing the certificate. The caller must free the memory for the buffer by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbCertRef"><dd> <p>Receives the size of the <em>ppCert</em> buffer, in bytes.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>Not implemented.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For certain version numbers of sample protection, the downstream component must provide a certificate. Components that do not support these version numbers can return E_NOTIMPL.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleProtection::GetProtectionCertificate']/*"/>
|
|
<msdn-id>bb970503</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleProtection::GetProtectionCertificate([In] unsigned int dwVersion,[Out, Buffer] unsigned char** ppCert,[Out] unsigned int* pcbCert)</unmanaged>
|
|
<unmanaged-short>IMFSampleProtection::GetProtectionCertificate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleProtection.InitOutputProtection(System.Int32,System.Int32,System.Byte,System.Int32,System.Byte,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves initialization information for sample protection from the upstream component.</p>
|
|
</summary>
|
|
<param name="dwVersion"><dd> <p>Specifies the version number of the sample protection scheme. The version number is specified as a <strong><see cref="T:SharpDX.MediaFoundation.SampleProtectionVersion"/></strong> enumeration value.</p> </dd></param>
|
|
<param name="dwOutputId"><dd> <p>Identifier of the output stream. The identifier corresponds to the output stream identifier returned by the <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> interface.</p> </dd></param>
|
|
<param name="bCertRef"><dd> <p>Pointer to a certificate provided by the downstream component.</p> </dd></param>
|
|
<param name="cbCert"><dd> <p>Size of the certificate, in bytes.</p> </dd></param>
|
|
<param name="bSeedOut"><dd> <p>Receives a reference to a buffer that contains the initialization information for downstream component. The caller must free the memory for the buffer by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbSeedRef"><dd> <p>Receives the size of the <em>ppbSeed</em> buffer, in bytes.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>Not implemented.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method must be implemented by the upstream component. The method fails if the component does not support the requested sample protection version. Downstream components do not implement this method and should return E_NOTIMPL.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleProtection::InitOutputProtection']/*"/>
|
|
<msdn-id>ms693577</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleProtection::InitOutputProtection([In] unsigned int dwVersion,[In] unsigned int dwOutputId,[In] unsigned char* pbCert,[In] unsigned int cbCert,[In] unsigned char** ppbSeed,[In] unsigned int* pcbSeed)</unmanaged>
|
|
<unmanaged-short>IMFSampleProtection::InitOutputProtection</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SampleProtection.InitInputProtection(System.Int32,System.Int32,System.Byte,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Initializes sample protection on the downstream component.</p>
|
|
</summary>
|
|
<param name="dwVersion"><dd> <p>Specifies the version number of the sample protection scheme. The version number is specified as a <strong><see cref="T:SharpDX.MediaFoundation.SampleProtectionVersion"/></strong> enumeration value.</p> </dd></param>
|
|
<param name="dwInputId"><dd> <p>Identifier of the input stream. The identifier corresponds to the output stream identifier returned by the <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> interface.</p> </dd></param>
|
|
<param name="bSeedRef"><dd> <p>Pointer to a buffer that contains the initialization data provided by the upstream component. To retrieve this buffer, call <strong><see cref="M:SharpDX.MediaFoundation.SampleProtection.InitOutputProtection(System.Int32,System.Int32,System.Byte,System.Int32,System.Byte,System.Int32)"/></strong>.</p> </dd></param>
|
|
<param name="cbSeed"><dd> <p>Size of the <em>pbSeed</em> buffer, in bytes.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleProtection::InitInputProtection']/*"/>
|
|
<msdn-id>ms696181</msdn-id>
|
|
<unmanaged>HRESULT IMFSampleProtection::InitInputProtection([In] unsigned int dwVersion,[In] unsigned int dwInputId,[In] unsigned char* pbSeed,[In] unsigned int cbSeed)</unmanaged>
|
|
<unmanaged-short>IMFSampleProtection::InitInputProtection</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.SampleProtection.InputProtectionVersion">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the version of sample protection that the component implements on input.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleProtection::GetInputProtectionVersion']/*"/>
|
|
<msdn-id>bb970365</msdn-id>
|
|
<unmanaged>GetInputProtectionVersion</unmanaged>
|
|
<unmanaged-short>GetInputProtectionVersion</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSampleProtection::GetInputProtectionVersion([Out] unsigned int* pdwVersion)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.SampleProtection.OutputProtectionVersion">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the version of sample protection that the component implements on output.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSampleProtection::GetOutputProtectionVersion']/*"/>
|
|
<msdn-id>bb970415</msdn-id>
|
|
<unmanaged>GetOutputProtectionVersion</unmanaged>
|
|
<unmanaged-short>GetOutputProtectionVersion</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSampleProtection::GetOutputProtectionVersion([Out] unsigned int* pdwVersion)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SaveJob">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Persists media data from a source byte stream to an application-provided byte stream.</p><p>The byte stream used for HTTP download implements this interface. To get a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> on the byte stream, with the service identifier MFNET_SAVEJOB_SERVICE.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSaveJob']/*"/>
|
|
<msdn-id>ms694247</msdn-id>
|
|
<unmanaged>IMFSaveJob</unmanaged>
|
|
<unmanaged-short>IMFSaveJob</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SaveJob.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SaveJob"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SaveJob.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SaveJob">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SaveJob"/>. (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.MediaFoundation.SaveJob.BeginSave(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Begins saving a Windows Media file to the application's byte stream.</p>
|
|
</summary>
|
|
<param name="streamRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface of the application's byte stream. The data from the source byte stream is written to this byte stream.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface</p> </dd></param>
|
|
<param name="stateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When the operation completes, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.SaveJob.EndSave(SharpDX.MediaFoundation.AsyncResult)"/></strong> to complete the asynchronous request.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSaveJob::BeginSave']/*"/>
|
|
<msdn-id>ms705664</msdn-id>
|
|
<unmanaged>HRESULT IMFSaveJob::BeginSave([In] IMFByteStream* pStream,[In] IMFAsyncCallback* pCallback,[In] IUnknown* pState)</unmanaged>
|
|
<unmanaged-short>IMFSaveJob::BeginSave</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SaveJob.EndSave(SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Completes the operation started by <strong><see cref="M:SharpDX.MediaFoundation.SaveJob.BeginSave(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p>
|
|
</summary>
|
|
<param name="resultRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSaveJob::EndSave']/*"/>
|
|
<msdn-id>ms701610</msdn-id>
|
|
<unmanaged>HRESULT IMFSaveJob::EndSave([In] IMFAsyncResult* pResult)</unmanaged>
|
|
<unmanaged-short>IMFSaveJob::EndSave</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SaveJob.CancelSave">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Cancels the operation started by <strong><see cref="M:SharpDX.MediaFoundation.SaveJob.BeginSave(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSaveJob::CancelSave']/*"/>
|
|
<msdn-id>ms703196</msdn-id>
|
|
<unmanaged>HRESULT IMFSaveJob::CancelSave()</unmanaged>
|
|
<unmanaged-short>IMFSaveJob::CancelSave</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SaveJob.GetProgress(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the percentage of content saved to the provided byte stream.</p>
|
|
</summary>
|
|
<param name="dwPercentCompleteRef"><dd> <p>Receives the percentage of completion.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSaveJob::GetProgress']/*"/>
|
|
<msdn-id>ms700176</msdn-id>
|
|
<unmanaged>HRESULT IMFSaveJob::GetProgress([Out] unsigned int* pdwPercentComplete)</unmanaged>
|
|
<unmanaged-short>IMFSaveJob::GetProgress</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.SaveJob.Progress">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the percentage of content saved to the provided byte stream.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSaveJob::GetProgress']/*"/>
|
|
<msdn-id>ms700176</msdn-id>
|
|
<unmanaged>GetProgress</unmanaged>
|
|
<unmanaged-short>GetProgress</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSaveJob::GetProgress([Out] unsigned int* pdwPercentComplete)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SchemeHandler">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Begins an asynchronous request to create an object from a URL.</p><p>When the Source Resolver creates a media source from a URL, it passes the request to a scheme handler. The scheme handler might create a media source directly from the URL, or it might return a byte stream. If it returns a byte stream, the source resolver use a byte-stream handler to create the media source from the byte stream.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The <em>dwFlags</em> parameter must contain the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong> flag or the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong> flag. If the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong> flag is set, the scheme handler might create the media source directly from the URL, or it might create a byte stream. The type of object is returned in the <em>pObjectType</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.SchemeHandler.EndCreateObject(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong> method. If the scheme handler returns a byte stream, the source resolver will pass the byte stream to a byte-stream handler, which will create the media source from the byte stream.</p><p>If the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong> flag is set, the scheme handler will attempt to create a byte stream from the URL. However, if the scheme handler is designed to create a media source directly, rather than a byte stream, the method will fail.</p><p>The following table summarizes the behavior of these two flags when passed to this method:</p><table> <tr><th>Flag</th><th>Object created</th></tr> <tr><td><strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong></td><td>Media source or byte stream</td></tr> <tr><td><strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong></td><td>Byte stream</td></tr> </table><p>?</p><p>The <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong> and <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong> flags can be combined, although in this case it is redundant.</p><p>When the operation completes, the scheme handler calls the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. The Invoke method should call <strong><see cref="M:SharpDX.MediaFoundation.SchemeHandler.EndCreateObject(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong> to get a reference to the created object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSchemeHandler']/*"/>
|
|
<msdn-id>bb970433</msdn-id>
|
|
<unmanaged>IMFSchemeHandler</unmanaged>
|
|
<unmanaged-short>IMFSchemeHandler</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SchemeHandler.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SchemeHandler"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SchemeHandler.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SchemeHandler">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SchemeHandler"/>. (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.MediaFoundation.SchemeHandler.BeginCreateObject(System.String,System.Int32,SharpDX.ComObject,SharpDX.ComObject@,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Begins an asynchronous request to create an object from a URL.</p><p>When the Source Resolver creates a media source from a URL, it passes the request to a scheme handler. The scheme handler might create a media source directly from the URL, or it might return a byte stream. If it returns a byte stream, the source resolver use a byte-stream handler to create the media source from the byte stream.</p>
|
|
</summary>
|
|
<param name="wszURLRef">No documentation.</param>
|
|
<param name="dwFlags">No documentation.</param>
|
|
<param name="propsRef">No documentation.</param>
|
|
<param name="iUnknownCancelCookieOut">No documentation.</param>
|
|
<param name="callbackRef">No documentation.</param>
|
|
<param name="unkStateRef">No documentation.</param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_ACCESSDENIED</strong></dt> </dl> </td><td> <p> Cannot open the URL with the requested access (read or write). </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_BYTESTREAM_TYPE</strong></dt> </dl> </td><td> <p> Unsupported byte stream type. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <em>dwFlags</em> parameter must contain the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong> flag or the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong> flag. If the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong> flag is set, the scheme handler might create the media source directly from the URL, or it might create a byte stream. The type of object is returned in the <em>pObjectType</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.SchemeHandler.EndCreateObject(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong> method. If the scheme handler returns a byte stream, the source resolver will pass the byte stream to a byte-stream handler, which will create the media source from the byte stream.</p><p>If the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong> flag is set, the scheme handler will attempt to create a byte stream from the URL. However, if the scheme handler is designed to create a media source directly, rather than a byte stream, the method will fail.</p><p>The following table summarizes the behavior of these two flags when passed to this method:</p><table> <tr><th>Flag</th><th>Object created</th></tr> <tr><td><strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong></td><td>Media source or byte stream</td></tr> <tr><td><strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong></td><td>Byte stream</td></tr> </table><p>?</p><p>The <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong> and <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong> flags can be combined, although in this case it is redundant.</p><p>When the operation completes, the scheme handler calls the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. The Invoke method should call <strong><see cref="M:SharpDX.MediaFoundation.SchemeHandler.EndCreateObject(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong> to get a reference to the created object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSchemeHandler::BeginCreateObject']/*"/>
|
|
<msdn-id>bb970433</msdn-id>
|
|
<unmanaged>HRESULT IMFSchemeHandler::BeginCreateObject([In] const wchar_t* pwszURL,[In] unsigned int dwFlags,[In] IPropertyStore* pProps,[Out, Optional] IUnknown** ppIUnknownCancelCookie,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFSchemeHandler::BeginCreateObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SchemeHandler.EndCreateObject(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="resultRef">No documentation.</param>
|
|
<param name="objectTypeRef">No documentation.</param>
|
|
<param name="objectOut">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='IMFSchemeHandler::EndCreateObject']/*"/>
|
|
<unmanaged>HRESULT IMFSchemeHandler::EndCreateObject([In] IMFAsyncResult* pResult,[Out] MF_OBJECT_TYPE* pObjectType,[Out] IUnknown** ppObject)</unmanaged>
|
|
<unmanaged-short>IMFSchemeHandler::EndCreateObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SchemeHandler.CancelObjectCreation(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Cancels the current request to create an object from a URL.</p>
|
|
</summary>
|
|
<param name="iUnknownCancelCookieRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface that was returned in the <em>ppIUnknownCancelCookie</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.SchemeHandler.BeginCreateObject(System.String,System.Int32,SharpDX.ComObject,SharpDX.ComObject@,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You can use this method to cancel a previous call to <strong>BeginCreateObject</strong>. Because that method is asynchronous, however, it might be completed before the operation can be canceled. Therefore, your callback might still be invoked after you call this method.</p><p>The operation cannot be canceled if <strong>BeginCreateObject</strong> returns <strong><c>null</c></strong> in the <em>ppIUnknownCancelCookie</em> parameter.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSchemeHandler::CancelObjectCreation']/*"/>
|
|
<msdn-id>bb970419</msdn-id>
|
|
<unmanaged>HRESULT IMFSchemeHandler::CancelObjectCreation([In] IUnknown* pIUnknownCancelCookie)</unmanaged>
|
|
<unmanaged-short>IMFSchemeHandler::CancelObjectCreation</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SecureChannel">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the client's certificate.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSecureChannel']/*"/>
|
|
<msdn-id>bb970528</msdn-id>
|
|
<unmanaged>IMFSecureChannel</unmanaged>
|
|
<unmanaged-short>IMFSecureChannel</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SecureChannel.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SecureChannel"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SecureChannel.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SecureChannel">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SecureChannel"/>. (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.MediaFoundation.SecureChannel.GetCertificate(System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the client's certificate.</p>
|
|
</summary>
|
|
<param name="certOut"><dd> <p>Receives a reference to a buffer allocated by the object. The buffer contains the client's certificate. The caller must release the buffer by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbCertRef"><dd> <p>Receives the size of the <em>ppCert</em> buffer, in bytes.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSecureChannel::GetCertificate']/*"/>
|
|
<msdn-id>bb970528</msdn-id>
|
|
<unmanaged>HRESULT IMFSecureChannel::GetCertificate([Out, Buffer] unsigned char** ppCert,[Out] unsigned int* pcbCert)</unmanaged>
|
|
<unmanaged-short>IMFSecureChannel::GetCertificate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SecureChannel.SetupSession(System.Byte[],System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Passes the encrypted session key to the client.</p>
|
|
</summary>
|
|
<param name="bEncryptedSessionKeyRef"><dd> <p>Pointer to a buffer that contains the encrypted session key. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="cbSessionKey"><dd> <p>Size of the <em>pbEncryptedSessionKey</em> buffer, in bytes.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSecureChannel::SetupSession']/*"/>
|
|
<msdn-id>bb970477</msdn-id>
|
|
<unmanaged>HRESULT IMFSecureChannel::SetupSession([In, Buffer] unsigned char* pbEncryptedSessionKey,[In] unsigned int cbSessionKey)</unmanaged>
|
|
<unmanaged-short>IMFSecureChannel::SetupSession</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SeekInfo">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>For a particular seek position, gets the two nearest key frames.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If an application seeks to a non?key frame, the decoder must start decoding from the previous key frame. This can increase latency, because several frames might get decoded before the requested frame is reached. To reduce latency, an application can call this method to find the two key frames that are closest to the desired time, and then seek to one of those key frames. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSeekInfo']/*"/>
|
|
<msdn-id>hh448055</msdn-id>
|
|
<unmanaged>IMFSeekInfo</unmanaged>
|
|
<unmanaged-short>IMFSeekInfo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SeekInfo.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SeekInfo"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SeekInfo.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SeekInfo">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SeekInfo"/>. (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.MediaFoundation.SeekInfo.GetNearestKeyFrames(System.Guid,SharpDX.Win32.Variant,SharpDX.Win32.Variant@,SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>For a particular seek position, gets the two nearest key frames.</p>
|
|
</summary>
|
|
<param name="guidTimeFormatRef"><dd> <p>A reference to a <see cref="T:System.Guid"/> that specifies the time format. The time format defines the units for the other parameters of this method. If the value is <strong>GUID_NULL</strong>, the time format is 100-nanosecond units. Some media sources might support additional time format GUIDs. </p> </dd></param>
|
|
<param name="varStartPositionRef"><dd> <p>The seek position. The units for this parameter are specified by <em>pguidTimeFormat</em>.</p> </dd></param>
|
|
<param name="varPreviousKeyFrameRef"><dd> <p>Receives the position of the nearest key frame that appears earlier than <em>pvarStartPosition</em>. The units for this parameter are specified by <em>pguidTimeFormat</em>.</p> </dd></param>
|
|
<param name="varNextKeyFrameRef"><dd> <p>Receives the position of the nearest key frame that appears earlier than <em>pvarStartPosition</em>. The units for this parameter are specified by <em>pguidTimeFormat</em>.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_TIME_FORMAT</strong></dt> </dl> </td><td> <p>The time format specified in <em>pguidTimeFormat</em> is not supported.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If an application seeks to a non?key frame, the decoder must start decoding from the previous key frame. This can increase latency, because several frames might get decoded before the requested frame is reached. To reduce latency, an application can call this method to find the two key frames that are closest to the desired time, and then seek to one of those key frames. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSeekInfo::GetNearestKeyFrames']/*"/>
|
|
<msdn-id>hh448055</msdn-id>
|
|
<unmanaged>HRESULT IMFSeekInfo::GetNearestKeyFrames([In] const GUID* pguidTimeFormat,[In] const PROPVARIANT* pvarStartPosition,[Out] PROPVARIANT* pvarPreviousKeyFrame,[Out] PROPVARIANT* pvarNextKeyFrame)</unmanaged>
|
|
<unmanaged-short>IMFSeekInfo::GetNearestKeyFrames</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SequencerSource">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Implemented by the Sequencer Source. The sequencer source enables an application to create a sequence of topologies. To create the sequencer source, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSequencerSource(SharpDX.ComObject,SharpDX.MediaFoundation.SequencerSource@)"/></strong>. For step-by-step instructions about how to create a playlist, see How to Create a Playlist.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSequencerSource']/*"/>
|
|
<msdn-id>ms702972</msdn-id>
|
|
<unmanaged>IMFSequencerSource</unmanaged>
|
|
<unmanaged-short>IMFSequencerSource</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SequencerSource.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SequencerSource"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SequencerSource.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SequencerSource">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SequencerSource"/>. (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.MediaFoundation.SequencerSource.AppendTopology(SharpDX.MediaFoundation.Topology,System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Adds a topology to the end of the queue.</p>
|
|
</summary>
|
|
<param name="topologyRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface of the topology. This reference cannot be <strong><c>null</c></strong>. If an application passes <strong><c>null</c></strong>, the call fails with an E_INVALIDARG error code.</p> </dd></param>
|
|
<param name="dwFlags"><dd> <p>A combination of flags from the <strong><see cref="T:SharpDX.MediaFoundation.SequencerTopologyFlags"/></strong> enumeration.</p> </dd></param>
|
|
<param name="dwIdRef"><dd> <p>Receives the sequencer element identifier for this topology.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_ATTRIBUTENOTFOUND</strong></dt> </dl> </td><td> <p>The source topology node is missing one of the following attributes:</p> <ul> <li> <p> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.StreamDescriptor"/></strong> </p> </li> <li> <p> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.PresentationDescriptor"/></strong> </p> </li> <li> <p> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Source"/></strong> </p> </li> </ul> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The sequencer plays topologies in the order they are queued. You can queue as many topologies as you want to preroll.</p><p>The application must indicate to the sequencer when it has queued the last topology on the Media Session. To specify the last topology, set the SequencerTopologyFlags_Last flag in the <em>dwFlags</em> parameter when you append the topology. The sequencer uses this information to end playback with the pipeline. Otherwise, the sequencer waits indefinitely for a new topology to be queued.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSequencerSource::AppendTopology']/*"/>
|
|
<msdn-id>ms697046</msdn-id>
|
|
<unmanaged>HRESULT IMFSequencerSource::AppendTopology([In] IMFTopology* pTopology,[In] unsigned int dwFlags,[Out] unsigned int* pdwId)</unmanaged>
|
|
<unmanaged-short>IMFSequencerSource::AppendTopology</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SequencerSource.DeleteTopology(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Deletes a topology from the queue.</p>
|
|
</summary>
|
|
<param name="dwId"><dd> <p>The sequencer element identifier of the topology to delete.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSequencerSource::DeleteTopology']/*"/>
|
|
<msdn-id>bb970428</msdn-id>
|
|
<unmanaged>HRESULT IMFSequencerSource::DeleteTopology([In] unsigned int dwId)</unmanaged>
|
|
<unmanaged-short>IMFSequencerSource::DeleteTopology</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SequencerSource.GetPresentationContext(SharpDX.MediaFoundation.PresentationDescriptor,System.Int32@,SharpDX.MediaFoundation.Topology@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Maps a presentation descriptor to its associated sequencer element identifier and the topology it represents.</p>
|
|
</summary>
|
|
<param name="pDRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.PresentationDescriptor"/></strong> interface of the presentation descriptor.</p> </dd></param>
|
|
<param name="idRef"><dd> <p>Receives the sequencer element identifier. This value is assigned by the sequencer source when the application calls <strong><see cref="M:SharpDX.MediaFoundation.SequencerSource.AppendTopology(SharpDX.MediaFoundation.Topology,System.Int32,System.Int32@)"/></strong>. This parameter is optional and can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="topologyOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface of the original topology that the application added to the sequencer source. The caller must release the interface. This parameter can receive the value <strong><c>null</c></strong> if the sequencer source has switched to the next presentation. This parameter is optional and can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The presentation descriptor is not valid.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_S_SEQUENCER_CONTEXT_CANCELED</strong></dt> </dl> </td><td> <p>This segment was canceled.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The topology returned in <em>ppTopology</em> is the original topology that the application specified in <strong>AppendTopology</strong>. The source nodes in this topology contain references to the native sources. Do not queue this topology on the Media Session. Instead, call <strong><see cref="M:SharpDX.MediaFoundation.MediaSourceTopologyProvider.GetMediaSourceTopology(SharpDX.MediaFoundation.PresentationDescriptor,SharpDX.MediaFoundation.Topology@)"/></strong> to get the sequencer source's modified topology. The source nodes in the modified topology contain references to the sequencer source, rather than the native sources.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSequencerSource::GetPresentationContext']/*"/>
|
|
<msdn-id>bb970514</msdn-id>
|
|
<unmanaged>HRESULT IMFSequencerSource::GetPresentationContext([In] IMFPresentationDescriptor* pPD,[Out, Optional] unsigned int* pId,[Out, Optional] IMFTopology** ppTopology)</unmanaged>
|
|
<unmanaged-short>IMFSequencerSource::GetPresentationContext</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SequencerSource.UpdateTopology(System.Int32,SharpDX.MediaFoundation.Topology)">
|
|
<summary>
|
|
<p>Updates a topology in the queue.</p> <see cref="T:SharpDX.Result"/> UpdateTopology( MFSequencerElementId dwId, <see cref="T:SharpDX.MediaFoundation.Topology"/>* pTopology );<p></p>Parameters <p> dwId </p> <p>[in] Sequencer element identifier of the topology to update.</p> <p> pTopology </p> <p>[in] Pointer to the <see cref="T:SharpDX.MediaFoundation.Topology"/> Interface of the updated topology object. </p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>MF_E_SHUTDOWN</p> </td> <td> <p>The sequencer source has been shut down.</p> </td> </tr></table> <p>This method is asynchronous. When the operation is completed, the sequencer source sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SequencerSourceTopologyUpdated"/> Event.</p> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFSequencerSource InterfaceOther ResourcesSequencer Source
|
|
</summary>
|
|
<param name="dwId">No documentation.</param>
|
|
<param name="topologyRef">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='IMFSequencerSource::UpdateTopology']/*"/>
|
|
<msdn-id>ms700212</msdn-id>
|
|
<unmanaged>HRESULT IMFSequencerSource::UpdateTopology([In] unsigned int dwId,[In] IMFTopology* pTopology)</unmanaged>
|
|
<unmanaged-short>IMFSequencerSource::UpdateTopology</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SequencerSource.UpdateTopologyFlags(System.Int32,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Updates the flags for a topology in the queue.</p>
|
|
</summary>
|
|
<param name="dwId"><dd> <p>Sequencer element identifier of the topology to update.</p> </dd></param>
|
|
<param name="dwFlags"><dd> <p>Bitwise <strong>OR</strong> of flags from the <strong><see cref="T:SharpDX.MediaFoundation.SequencerTopologyFlags"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSequencerSource::UpdateTopologyFlags']/*"/>
|
|
<msdn-id>bb970564</msdn-id>
|
|
<unmanaged>HRESULT IMFSequencerSource::UpdateTopologyFlags([In] unsigned int dwId,[In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IMFSequencerSource::UpdateTopologyFlags</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ServiceProvider">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Queries an object for a specified service interface. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>A service is an interface that is exposed by one object but might be implemented by another object. The <strong>GetService</strong> method is equivalent to <strong>QueryInterface</strong>, with the following difference: when <strong>QueryInterface</strong> retrieves a reference to an interface, it is guaranteed that you can query the returned interface and get back the original interface. The <strong>GetService</strong> method does not make this guarantee, because the retrieved interface might be implemented by a separate object.</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.GetService(SharpDX.ComObject,System.Guid,System.Guid,System.IntPtr@)"/></strong> function is a helper function that queries an object for <strong><see cref="T:SharpDX.MediaFoundation.ServiceProvider"/></strong> and calls the <strong>GetService</strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFGetService']/*"/>
|
|
<msdn-id>ms694261</msdn-id>
|
|
<unmanaged>IMFGetService</unmanaged>
|
|
<unmanaged-short>IMFGetService</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ServiceProvider.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.ServiceProvider"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.ServiceProvider.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.ServiceProvider">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.ServiceProvider"/>. (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.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a service interface.</p>
|
|
</summary>
|
|
<param name="guidService"><dd> <p>The service identifier (SID) of the service. For a list of service identifiers, see Service Interfaces.</p> </dd></param>
|
|
<param name="riid"><dd> <p>The interface identifier (IID) of the interface being requested.</p> </dd></param>
|
|
<param name="vObjectOut"><dd> <p>Receives the interface reference. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_SERVICE</strong></dt> </dl> </td><td> <p>The object does not support the service.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFGetService::GetService']/*"/>
|
|
<msdn-id>ms696978</msdn-id>
|
|
<unmanaged>HRESULT IMFGetService::GetService([In] const GUID& guidService,[In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
|
|
<unmanaged-short>IMFGetService::GetService</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Shutdownable">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Queries the status of an earlier call to the <strong><see cref="M:SharpDX.MediaFoundation.Shutdownable.Shutdown"/></strong> method. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Until <strong>Shutdown</strong> is called, the <strong>GetShutdownStatus</strong> method returns <strong>MF_E_INVALIDREQUEST</strong>.</p><p>If an object's <strong>Shutdown</strong> method is asynchronous, <em>pStatus</em> might receive the value <strong><see cref="F:SharpDX.MediaFoundation.ShutdownStatus.Initiated"/></strong>. When the object is completely shut down, <em>pStatus</em> receives the value <strong><see cref="F:SharpDX.MediaFoundation.ShutdownStatus.Completed"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFShutdown']/*"/>
|
|
<msdn-id>bb970451</msdn-id>
|
|
<unmanaged>IMFShutdown</unmanaged>
|
|
<unmanaged-short>IMFShutdown</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Shutdownable.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Shutdownable"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Shutdownable.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Shutdownable">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Shutdownable"/>. (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.MediaFoundation.Shutdownable.Shutdown">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Shuts down a Media Foundation object and releases all resources associated with the object. </p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.ShutdownObject(SharpDX.ComObject)"/></strong> helper function is equivalent to calling this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFShutdown::Shutdown']/*"/>
|
|
<msdn-id>ms701615</msdn-id>
|
|
<unmanaged>HRESULT IMFShutdown::Shutdown()</unmanaged>
|
|
<unmanaged-short>IMFShutdown::Shutdown</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Shutdownable.GetShutdownStatus(SharpDX.MediaFoundation.ShutdownStatus@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Queries the status of an earlier call to the <strong><see cref="M:SharpDX.MediaFoundation.Shutdownable.Shutdown"/></strong> method. </p>
|
|
</summary>
|
|
<param name="statusRef">No documentation.</param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid argument.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p> The <strong>Shutdown</strong> method has not been called on this object. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Until <strong>Shutdown</strong> is called, the <strong>GetShutdownStatus</strong> method returns <strong>MF_E_INVALIDREQUEST</strong>.</p><p>If an object's <strong>Shutdown</strong> method is asynchronous, <em>pStatus</em> might receive the value <strong><see cref="F:SharpDX.MediaFoundation.ShutdownStatus.Initiated"/></strong>. When the object is completely shut down, <em>pStatus</em> receives the value <strong><see cref="F:SharpDX.MediaFoundation.ShutdownStatus.Completed"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFShutdown::GetShutdownStatus']/*"/>
|
|
<msdn-id>bb970451</msdn-id>
|
|
<unmanaged>HRESULT IMFShutdown::GetShutdownStatus([Out] MFSHUTDOWN_STATUS* pStatus)</unmanaged>
|
|
<unmanaged-short>IMFShutdown::GetShutdownStatus</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Shutdownable.ShutdownStatus">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Queries the status of an earlier call to the <strong><see cref="M:SharpDX.MediaFoundation.Shutdownable.Shutdown"/></strong> method. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Until <strong>Shutdown</strong> is called, the <strong>GetShutdownStatus</strong> method returns <strong>MF_E_INVALIDREQUEST</strong>.</p><p>If an object's <strong>Shutdown</strong> method is asynchronous, <em>pStatus</em> might receive the value <strong><see cref="F:SharpDX.MediaFoundation.ShutdownStatus.Initiated"/></strong>. When the object is completely shut down, <em>pStatus</em> receives the value <strong><see cref="F:SharpDX.MediaFoundation.ShutdownStatus.Completed"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFShutdown::GetShutdownStatus']/*"/>
|
|
<msdn-id>bb970451</msdn-id>
|
|
<unmanaged>GetShutdownStatus</unmanaged>
|
|
<unmanaged-short>GetShutdownStatus</unmanaged-short>
|
|
<unmanaged>HRESULT IMFShutdown::GetShutdownStatus([Out] MFSHUTDOWN_STATUS* pStatus)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SignedLibrary">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Provides a method that allows content protection systems to get the procedure address of a function in the signed library. This method provides the same functionality as <strong>GetProcAddress</strong> which is not available to Metro style apps.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>See <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LoadSignedLibrary(System.String,SharpDX.MediaFoundation.SignedLibrary@)"/></strong> for an example of how to create and use an <strong><see cref="T:SharpDX.MediaFoundation.SignedLibrary"/></strong> object.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSignedLibrary']/*"/>
|
|
<msdn-id>hh448058</msdn-id>
|
|
<unmanaged>IMFSignedLibrary</unmanaged>
|
|
<unmanaged-short>IMFSignedLibrary</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SignedLibrary.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SignedLibrary"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SignedLibrary.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SignedLibrary">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SignedLibrary"/>. (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.MediaFoundation.SignedLibrary.GetProcedureAddress(System.String,System.IntPtr@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the procedure address of the specified function in the signed library.</p>
|
|
</summary>
|
|
<param name="name"><dd> <p>The entry point name in the DLL that specifies the function.</p> </dd></param>
|
|
<param name="address"><dd> <p>Receives the address of the entry point.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>See <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.LoadSignedLibrary(System.String,SharpDX.MediaFoundation.SignedLibrary@)"/></strong> for an example of how to create an <strong><see cref="T:SharpDX.MediaFoundation.SignedLibrary"/></strong> object and call the <strong>GetProcedureAddress</strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSignedLibrary::GetProcedureAddress']/*"/>
|
|
<msdn-id>hh448059</msdn-id>
|
|
<unmanaged>HRESULT IMFSignedLibrary::GetProcedureAddress([In] const char* name,[Out] void** address)</unmanaged>
|
|
<unmanaged-short>IMFSignedLibrary::GetProcedureAddress</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SimpleAudioVolume">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls the master volume level of the audio session associated with the streaming audio renderer (SAR) and the audio capture source.</p><p>The SAR and the audio capture source expose this interface as a service. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. For the SAR, use the service identifier MR_POLICY_VOLUME_SERVICE. For the audio capture source, use the service identifier MR_CAPTURE_POLICY_VOLUME_SERVICE. You can call <strong>GetService</strong> directly on the SAR or the audio capture source, or call it on the Media Session.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To control the volume levels of individual channels, use the <strong><see cref="T:SharpDX.MediaFoundation.AudioStreamVolume"/></strong> interface. The <strong><see cref="T:SharpDX.MediaFoundation.AudioStreamVolume"/></strong> interface is supported by the SAR only.</p><p>Volume is expressed as an attenuation level, where 0.0 indicates silence and 1.0 indicates full volume (no attenuation). For each channel, the attenuation level is the product of:</p><ul> <li> <p>The master volume level of the audio session.</p> </li> <li> <p>The volume level of the channel.</p> </li> </ul><p>For example, if the master volume is 0.8 and the channel volume is 0.5, the attenuaton for that channel is 0.8 ? 0.5 = 0.4. Volume levels can exceed 1.0 (positive gain), but the audio engine clips any audio samples that exceed zero decibels. To change the volume level of individual channels, use the <strong><see cref="T:SharpDX.MediaFoundation.AudioStreamVolume"/></strong> interface.</p><p>Use the following formula to convert the volume level to the decibel (dB) scale:</p><p> Attenuation (dB) = 20 * log10(<em>Level</em>) </p><p>For example, a volume level of 0.50 represents 6.02 dB of attenuation.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSimpleAudioVolume']/*"/>
|
|
<msdn-id>ms693496</msdn-id>
|
|
<unmanaged>IMFSimpleAudioVolume</unmanaged>
|
|
<unmanaged-short>IMFSimpleAudioVolume</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SimpleAudioVolume.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SimpleAudioVolume"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SimpleAudioVolume.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SimpleAudioVolume">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SimpleAudioVolume"/>. (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.MediaFoundation.SimpleAudioVolume.SetMasterVolume(System.Single)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the master volume level.</p>
|
|
</summary>
|
|
<param name="fLevel"><dd> <p>Volume level. Volume is expressed as an attenuation level, where 0.0 indicates silence and 1.0 indicates full volume (no attenuation).</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The audio renderer is not initialized.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINK_REMOVED</strong></dt> </dl> </td><td> <p>The audio renderer was removed from the pipeline.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Events outside of the application can change the master volume level. For example, the user can change the volume from the system volume-control program (SndVol). If an external event changes the master volume, the audio renderer sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionVolumeChanged"/> event, which the Media Session forwards to the application.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSimpleAudioVolume::SetMasterVolume']/*"/>
|
|
<msdn-id>bb970391</msdn-id>
|
|
<unmanaged>HRESULT IMFSimpleAudioVolume::SetMasterVolume([In] float fLevel)</unmanaged>
|
|
<unmanaged-short>IMFSimpleAudioVolume::SetMasterVolume</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SimpleAudioVolume.GetMasterVolume(System.Single@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the master volume level.</p>
|
|
</summary>
|
|
<param name="fLevelRef"><dd> <p>Receives the volume level. Volume is expressed as an attenuation level, where 0.0 indicates silence and 1.0 indicates full volume (no attenuation).</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The audio renderer is not initialized.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINK_REMOVED</strong></dt> </dl> </td><td> <p>The audio renderer was removed from the pipeline.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If an external event changes the master volume, the audio renderer sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionVolumeChanged"/> event, which the Media Session forwards to the application.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSimpleAudioVolume::GetMasterVolume']/*"/>
|
|
<msdn-id>bb970319</msdn-id>
|
|
<unmanaged>HRESULT IMFSimpleAudioVolume::GetMasterVolume([Out] float* pfLevel)</unmanaged>
|
|
<unmanaged-short>IMFSimpleAudioVolume::GetMasterVolume</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SimpleAudioVolume.SetMute(System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Mutes or unmutes the audio.</p>
|
|
</summary>
|
|
<param name="bMute"><dd> <p>Specify <strong>TRUE</strong> to mute the audio, or <strong><see cref="F:SharpDX.Result.False"/></strong> to unmute the audio.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The audio renderer is not initialized.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINK_REMOVED</strong></dt> </dl> </td><td> <p>The audio renderer was removed from the pipeline.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method does not change the volume level returned by the <strong><see cref="M:SharpDX.MediaFoundation.SimpleAudioVolume.GetMasterVolume(System.Single@)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSimpleAudioVolume::SetMute']/*"/>
|
|
<msdn-id>bb970531</msdn-id>
|
|
<unmanaged>HRESULT IMFSimpleAudioVolume::SetMute([In] const BOOL bMute)</unmanaged>
|
|
<unmanaged-short>IMFSimpleAudioVolume::SetMute</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SimpleAudioVolume.GetMute(System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Queries whether the audio is muted.</p>
|
|
</summary>
|
|
<param name="bMuteRef"><dd> <p>Receives a Boolean value. If <strong>TRUE</strong>, the audio is muted; otherwise, the audio is not muted.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The audio renderer is not initialized.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINK_REMOVED</strong></dt> </dl> </td><td> <p>The audio renderer was removed from the pipeline.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Calling <strong><see cref="M:SharpDX.MediaFoundation.SimpleAudioVolume.SetMasterVolume(System.Single)"/></strong> to set the volume does not change whether the audio is muted.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSimpleAudioVolume::GetMute']/*"/>
|
|
<msdn-id>bb970332</msdn-id>
|
|
<unmanaged>HRESULT IMFSimpleAudioVolume::GetMute([Out] BOOL* pbMute)</unmanaged>
|
|
<unmanaged-short>IMFSimpleAudioVolume::GetMute</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.SimpleAudioVolume.MasterVolume">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the master volume level.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If an external event changes the master volume, the audio renderer sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.AudioSessionVolumeChanged"/> event, which the Media Session forwards to the application.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSimpleAudioVolume::GetMasterVolume']/*"/>
|
|
<msdn-id>bb970319</msdn-id>
|
|
<unmanaged>GetMasterVolume</unmanaged>
|
|
<unmanaged-short>GetMasterVolume</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSimpleAudioVolume::GetMasterVolume([Out] float* pfLevel)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.SimpleAudioVolume.Mute">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Queries whether the audio is muted.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Calling <strong><see cref="M:SharpDX.MediaFoundation.SimpleAudioVolume.SetMasterVolume(System.Single)"/></strong> to set the volume does not change whether the audio is muted.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSimpleAudioVolume::GetMute']/*"/>
|
|
<msdn-id>bb970332</msdn-id>
|
|
<unmanaged>GetMute</unmanaged>
|
|
<unmanaged-short>GetMute</unmanaged-short>
|
|
<unmanaged>HRESULT IMFSimpleAudioVolume::GetMute([Out] BOOL* pbMute)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SinkWriter">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Implemented by the Microsoft Media Foundation sink writer object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To create the sink writer, call one of the following functions:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSinkWriterFromMediaSink(SharpDX.MediaFoundation.MediaSink,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SinkWriter@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSinkWriterFromURL(System.String,SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SinkWriter@)"/></strong> </li> </ul><p>Alternatively, use the <strong><see cref="T:SharpDX.MediaFoundation.ReadWriteClassFactory"/></strong> interface.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter']/*"/>
|
|
<msdn-id>dd374642</msdn-id>
|
|
<unmanaged>IMFSinkWriter</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SinkWriter"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SinkWriter">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SinkWriter"/>. (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.MediaFoundation.SinkWriter.AddStream(SharpDX.MediaFoundation.MediaType,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Adds a stream to the sink writer.</p>
|
|
</summary>
|
|
<param name="targetMediaTypeRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of a media type. This media type specifies the format of the samples that will be written to the file. It does not need to match the input format. To set the input format, call <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.SetInputMediaType(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaAttributes)"/></strong>.</p> </dd></param>
|
|
<param name="dwStreamIndexRef"><dd> <p>Receives the zero-based index of the new stream.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::AddStream']/*"/>
|
|
<msdn-id>dd374646</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::AddStream([In] IMFMediaType* pTargetMediaType,[Out] unsigned int* pdwStreamIndex)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::AddStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.SetInputMediaType(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaAttributes)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Sets the input format for a stream on the sink writer.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The zero-based index of the stream. The index is received by the <em>pdwStreamIndex</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.AddStream(SharpDX.MediaFoundation.MediaType,System.Int32@)"/></strong> method.</p> </dd></param>
|
|
<param name="inputMediaTypeRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of a media type. The media type specifies the input format.</p> </dd></param>
|
|
<param name="encodingParametersRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of an attribute store. Use the attribute store to configure the encoder. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDMEDIATYPE</strong></strong></dt> </dl> </td><td> <p>The underlying media sink does not support the format, no conversion is possible, or a dynamic format change is not possible.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDSTREAMNUMBER</strong></strong></dt> </dl> </td><td> <p>The <em>dwStreamIndex</em> parameter is invalid.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_TOPO_CODEC_NOT_FOUND</strong></strong></dt> </dl> </td><td> <p>Could not find an encoder for the encoded format.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The input format does not have to match the target format that is written to the media sink. If the formats do not match, the method attempts to load an encoder that can encode from the input format to the target format.</p><p>After streaming begins?that is, after the first call to <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.WriteSample(System.Int32,SharpDX.MediaFoundation.Sample)"/></strong>?you can call this method at any time to change the input format. However, the underlying encoder and media sink must support dynamic format changes.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::SetInputMediaType']/*"/>
|
|
<msdn-id>dd374653</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::SetInputMediaType([In] unsigned int dwStreamIndex,[In] IMFMediaType* pInputMediaType,[In, Optional] IMFAttributes* pEncodingParameters)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::SetInputMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.BeginWriting">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes the sink writer for writing.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The request is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method after you configure the input streams and before you send any data to the sink writer. </p><p>You must call <strong>BeginWriting</strong> before calling any of the following methods:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.Finalize"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.Flush(System.Int32)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.NotifyEndOfSegment(System.Int32)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.PlaceMarker(System.Int32,System.IntPtr)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.SendStreamTick(System.Int32,System.Int64)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.WriteSample(System.Int32,SharpDX.MediaFoundation.Sample)"/></strong> </li> </ul><p>The underlying media sink must have at least one input stream. Otherwise, <strong>BeginWriting</strong> returns <strong>MF_E_INVALIDREQUEST</strong>. To add input streams, call the <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.AddStream(SharpDX.MediaFoundation.MediaType,System.Int32@)"/></strong> method.</p><p>If <strong>BeginWriting</strong> succeeds, any further calls to <strong>BeginWriting</strong> return <strong>MF_E_INVALIDREQUEST</strong>.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::BeginWriting']/*"/>
|
|
<msdn-id>dd374647</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::BeginWriting()</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::BeginWriting</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.WriteSample(System.Int32,SharpDX.MediaFoundation.Sample)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Delivers a sample to the sink writer.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The zero-based index of the stream for this sample.</p> </dd></param>
|
|
<param name="sampleRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of the sample.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The request is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You must call <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.BeginWriting"/></strong> before calling this method. Otherwise, the method returns <strong>MF_E_INVALIDREQUEST</strong>.</p><p>By default, the sink writer limits the rate of incoming data by blocking the calling thread inside the <strong>WriteSample</strong> method. This prevents the application from delivering samples too quickly. To disable this behavior, set the <see cref="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.DisableThrottling"/> attribute when you create the sink writer.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::WriteSample']/*"/>
|
|
<msdn-id>dd374654</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::WriteSample([In] unsigned int dwStreamIndex,[In] IMFSample* pSample)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::WriteSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.SendStreamTick(System.Int32,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Indicates a gap in an input stream.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The zero-based index of the stream.</p> </dd></param>
|
|
<param name="llTimestamp"><dd> <p>The position in the stream where the gap in the data occurs. The value is given in 100-nanosecond units, relative to the start of the stream.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>For video, call this method once for each missing frame. For audio, call this method at least once per second during a gap in the audio. Set the <strong><see cref="F:SharpDX.MediaFoundation.SampleAttributeKeys.Discontinuity"/></strong> attribute on the first media sample after the gap.</p><p>Internally, this method calls <strong><see cref="M:SharpDX.MediaFoundation.StreamSink.PlaceMarker(SharpDX.MediaFoundation.StreamsinkMarkerType,SharpDX.Win32.Variant,SharpDX.Win32.Variant)"/></strong> on the media sink.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::SendStreamTick']/*"/>
|
|
<msdn-id>dd374652</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::SendStreamTick([In] unsigned int dwStreamIndex,[In] longlong llTimestamp)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::SendStreamTick</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.PlaceMarker(System.Int32,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Places a marker in the specified stream.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The zero-based index of the stream.</p> </dd></param>
|
|
<param name="vContextRef"><dd> <p>Pointer to an application-defined value. The value of this parameter is returned to the caller in the <em>pvContext</em> parameter of the caller's <strong><see cref="M:SharpDX.MediaFoundation.SinkWriterCallback.OnMarker(System.Int32,System.IntPtr)"/></strong> callback method. The application is responsible for any memory allocation associated with this data. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The request is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>To use this method, you must provide an asynchronous callback when you create the sink writer. Otherwise, the method returns <strong>MF_E_INVALIDREQUEST</strong>. For more information, see <see cref="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.AsyncCallback"/>.</p><p>Markers provide a way to be notified when the media sink consumes all of the samples in a stream up to a certain point. The media sink does not process the marker until it has processed all of the samples that came before the marker. When the media sink processes the marker, the sink writer calls the application's <strong>OnMarker</strong> method. When the callback is invoked, you know that the sink has consumed all of the previous samples for that stream.</p><p>For example, to change the format midstream, call <strong>PlaceMarker</strong> at the point where the format changes. When <strong>OnMarker</strong> is called, it is safe to call <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.SetInputMediaType(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaAttributes)"/></strong> to change the input type (assuming that the media sink supports dynamic format changes).</p><p>Internally, this method calls <strong><see cref="M:SharpDX.MediaFoundation.StreamSink.PlaceMarker(SharpDX.MediaFoundation.StreamsinkMarkerType,SharpDX.Win32.Variant,SharpDX.Win32.Variant)"/></strong> on the media sink.</p><p> </p><p><strong>Note</strong>??The <em>pvContext</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.PlaceMarker(System.Int32,System.IntPtr)"/></strong> method is not passed to the <em>pvarContextValue</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.StreamSink.PlaceMarker(SharpDX.MediaFoundation.StreamsinkMarkerType,SharpDX.Win32.Variant,SharpDX.Win32.Variant)"/></strong> method. These two parameters are not directly related.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::PlaceMarker']/*"/>
|
|
<msdn-id>dd374651</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::PlaceMarker([In] unsigned int dwStreamIndex,[In] void* pvContext)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::PlaceMarker</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.NotifyEndOfSegment(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Notifies the media sink that a stream has reached the end of a segment.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The zero-based index of a stream, or <strong><see cref="F:SharpDX.MediaFoundation.SinkWriterIndex.AllStreams"/></strong> to signal that all streams have reached the end of a segment.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The request is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You must call <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.BeginWriting"/></strong> before calling this method. Otherwise, the method returns <strong>MF_E_INVALIDREQUEST</strong>.</p><p>This method sends an <strong><see cref="F:SharpDX.MediaFoundation.StreamsinkMarkerType.Endofsegment"/></strong> marker to the media sink for the specified streams. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.StreamSink.PlaceMarker(SharpDX.MediaFoundation.StreamsinkMarkerType,SharpDX.Win32.Variant,SharpDX.Win32.Variant)"/></strong>.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::NotifyEndOfSegment']/*"/>
|
|
<msdn-id>dd743366</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::NotifyEndOfSegment([In] unsigned int dwStreamIndex)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::NotifyEndOfSegment</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.Flush(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Flushes one or more streams.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The zero-based index of the stream to flush, or <strong><see cref="F:SharpDX.MediaFoundation.SinkWriterIndex.AllStreams"/></strong> to flush all of the streams.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>The request is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You must call <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.BeginWriting"/></strong> before calling this method. Otherwise, the method returns <strong>MF_E_INVALIDREQUEST</strong>.</p><p>For each stream that is flushed, the sink writer drops all pending samples, flushes the encoder, and sends an <strong><see cref="F:SharpDX.MediaFoundation.StreamsinkMarkerType.Endofsegment"/></strong> marker to the media sink.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::Flush']/*"/>
|
|
<msdn-id>dd743365</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::Flush([In] unsigned int dwStreamIndex)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::Flush</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.Finalize">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Completes all writing operations on the sink writer.</p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call this method after you send all of the input samples to the sink writer. The method performs any operations needed to create the final output from the media sink.</p><p>If you provide a callback interface when you create the sink writer, this method completes asynchronously. When the operation completes, the <strong><see cref="M:SharpDX.MediaFoundation.SinkWriterCallback.OnFinalize(SharpDX.Result)"/></strong> method of your callback is called. For more information, see <see cref="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.AsyncCallback"/>. Otherwise, if you do not provide a callback, the <strong>Finalize</strong> method blocks until the operation completes.</p><p>Internally, this method calls <strong><see cref="M:SharpDX.MediaFoundation.StreamSink.PlaceMarker(SharpDX.MediaFoundation.StreamsinkMarkerType,SharpDX.Win32.Variant,SharpDX.Win32.Variant)"/></strong> to place end-of-segment markers for each stream on the media sink. It also calls <strong><see cref="M:SharpDX.MediaFoundation.FinalizableMediaSink.BeginFinalize(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> and <strong>EndFinalize</strong> if the media sink supports the <strong><see cref="T:SharpDX.MediaFoundation.FinalizableMediaSink"/></strong> interface.</p><p>After this method is called, the following methods will fail:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.PlaceMarker(System.Int32,System.IntPtr)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.SendStreamTick(System.Int32,System.Int64)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.WriteSample(System.Int32,SharpDX.MediaFoundation.Sample)"/></strong> </li> </ul><p>If you do not call <strong>Finalize</strong>, the output from the media sink might be incomplete or invalid. For example, required file headers might be missing from the output file.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::Finalize']/*"/>
|
|
<msdn-id>dd374648</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::Finalize()</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::Finalize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.GetServiceForStream(System.Int32,System.Guid,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Queries the underlying media sink or encoder for an interface.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The zero-based index of a stream to query, or <strong><see cref="F:SharpDX.MediaFoundation.SinkWriterIndex.Mediasink"/></strong> to query the media sink itself.</p> </dd></param>
|
|
<param name="guidService"><dd> <p>A service identifier <see cref="T:System.Guid"/>, or <strong>GUID_NULL</strong>. If the value is <strong>GUID_NULL</strong>, the method calls <strong>QueryInterface</strong> to get the requested interface. Otherwise, the method calls <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. For a list of service identifiers, see Service Interfaces.</p> </dd></param>
|
|
<param name="riid"><dd> <p>The interface identifier (IID) of the interface being requested. </p> </dd></param>
|
|
<param name="vObjectOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>If the <em>dwStreamIndex</em> parameter equals <strong><see cref="F:SharpDX.MediaFoundation.SinkWriterIndex.Mediasink"/></strong>, the method attempts to get the interface from the media sink. Otherwise, it attempts to get the interface from the encoder for the stream at the specified index. If that fails, or if no encoder is present, the method attempts to get the interface from the stream on the media sink.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::GetServiceForStream']/*"/>
|
|
<msdn-id>dd374649</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::GetServiceForStream([In] unsigned int dwStreamIndex,[In] const GUID& guidService,[In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::GetServiceForStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriter.GetStatistics(System.Int32,SharpDX.MediaFoundation.SinkWriterStatistics@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets statistics about the performance of the sink writer.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The zero-based index of a stream to query, or <strong><see cref="F:SharpDX.MediaFoundation.SinkWriterIndex.AllStreams"/> </strong> to query the media sink itself.</p> </dd></param>
|
|
<param name="statsRef"><dd> <p>A reference to an <strong><see cref="T:SharpDX.MediaFoundation.SinkWriterStatistics"/></strong> structure. Before calling the method, set the <strong>cb</strong> member to the size of the structure in bytes. The method fills the structure with statistics from the sink writer.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p>Invalid stream number.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriter::GetStatistics']/*"/>
|
|
<msdn-id>dd374650</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriter::GetStatistics([In] unsigned int dwStreamIndex,[Out] MF_SINK_WRITER_STATISTICS* pStats)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriter::GetStatistics</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SinkWriterCallback">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Callback interface for the Microsoft Media Foundation sink writer. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Set the callback reference by setting the <see cref="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.AsyncCallback"/> attribute when you first create the sink writer. </p><p>The callback methods can be called from any thread, so an object that implements this interface must be thread-safe.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriterCallback']/*"/>
|
|
<msdn-id>dd374643</msdn-id>
|
|
<unmanaged>IMFSinkWriterCallback</unmanaged>
|
|
<unmanaged-short>IMFSinkWriterCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriterCallback.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SinkWriterCallback"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriterCallback.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SinkWriterCallback">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SinkWriterCallback"/>. (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.MediaFoundation.SinkWriterCallback.OnFinalize(SharpDX.Result)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Called when the <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.Finalize"/></strong> method completes.</p>
|
|
</summary>
|
|
<param name="hrStatus">No documentation.</param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Currently, the sink writer ignores the return value.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriterCallback::OnFinalize']/*"/>
|
|
<msdn-id>dd374644</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriterCallback::OnFinalize([In] HRESULT hrStatus)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriterCallback::OnFinalize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriterCallback.OnMarker(System.Int32,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Called when the <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.PlaceMarker(System.Int32,System.IntPtr)"/></strong> method completes.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex">No documentation.</param>
|
|
<param name="vContextRef">No documentation.</param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Currently, the sink writer ignores the return value.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriterCallback::OnMarker']/*"/>
|
|
<msdn-id>dd374645</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriterCallback::OnMarker([In] unsigned int dwStreamIndex,[In] void* pvContext)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriterCallback::OnMarker</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SinkWriterEx">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets a reference to a Media Foundation transform (MFT) for a specified stream.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriterEx']/*"/>
|
|
<msdn-id>hh448061</msdn-id>
|
|
<unmanaged>IMFSinkWriterEx</unmanaged>
|
|
<unmanaged-short>IMFSinkWriterEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriterEx.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SinkWriterEx"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SinkWriterEx.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SinkWriterEx">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SinkWriterEx"/>. (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.MediaFoundation.SinkWriterEx.GetTransformForStream(System.Int32,System.Int32,System.Guid@,SharpDX.MediaFoundation.Transform@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets a reference to a Media Foundation transform (MFT) for a specified stream.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The zero-based index of a stream.</p> </dd></param>
|
|
<param name="dwTransformIndex"><dd> <p>The zero-based index of the MFT to retreive.</p> </dd></param>
|
|
<param name="guidCategoryRef"><dd> <p>Receives a reference to a <see cref="T:System.Guid"/> that specifies the category of the MFT. For a list of possible values, see <strong>MFT_CATEGORY</strong>.</p> </dd></param>
|
|
<param name="transformOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> interface of the MFT. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSinkWriterEx::GetTransformForStream']/*"/>
|
|
<msdn-id>hh448061</msdn-id>
|
|
<unmanaged>HRESULT IMFSinkWriterEx::GetTransformForStream([In] unsigned int dwStreamIndex,[In] unsigned int dwTransformIndex,[Out, Optional] GUID* pGuidCategory,[Out] IMFTransform** ppTransform)</unmanaged>
|
|
<unmanaged-short>IMFSinkWriterEx::GetTransformForStream</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SourceOpenMonitor">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called by the network source when the open operation begins or ends.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The networks source calls this method with the following event types.</p><ul> <li> <p> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.ConnectStart"/> </p> </li> <li> <p> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.ConnectEnd"/> </p> </li> </ul><p>For more information, see How to Get Events from the Network Source.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceOpenMonitor']/*"/>
|
|
<msdn-id>ms694870</msdn-id>
|
|
<unmanaged>IMFSourceOpenMonitor</unmanaged>
|
|
<unmanaged-short>IMFSourceOpenMonitor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceOpenMonitor.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SourceOpenMonitor"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceOpenMonitor.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SourceOpenMonitor">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SourceOpenMonitor"/>. (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.MediaFoundation.SourceOpenMonitor.OnSourceEvent(SharpDX.MediaFoundation.MediaEvent)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Called by the network source when the open operation begins or ends.</p>
|
|
</summary>
|
|
<param name="eventRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaEvent"/></strong> interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The networks source calls this method with the following event types.</p><ul> <li> <p> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.ConnectStart"/> </p> </li> <li> <p> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.ConnectEnd"/> </p> </li> </ul><p>For more information, see How to Get Events from the Network Source.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceOpenMonitor::OnSourceEvent']/*"/>
|
|
<msdn-id>ms694870</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceOpenMonitor::OnSourceEvent([In, Optional] IMFMediaEvent* pEvent)</unmanaged>
|
|
<unmanaged-short>IMFSourceOpenMonitor::OnSourceEvent</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SourceReader">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Implemented by the Microsoft Media Foundation source reader object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To create the source reader, call one of the following functions:</p><ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSourceReaderFromByteStream(SharpDX.MediaFoundation.ByteStream,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SourceReader@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSourceReaderFromMediaSource(SharpDX.MediaFoundation.MediaSource,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SourceReader@)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateSourceReaderFromURL(System.String,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.SourceReader@)"/></strong> </li> </ul><p>Alternatively, use the <strong><see cref="T:SharpDX.MediaFoundation.ReadWriteClassFactory"/></strong> interface.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader']/*"/>
|
|
<msdn-id>dd374655</msdn-id>
|
|
<unmanaged>IMFSourceReader</unmanaged>
|
|
<unmanaged-short>IMFSourceReader</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SourceReader"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SourceReader">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SourceReader"/>. (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.MediaFoundation.SourceReader.GetStreamSelection(System.Int32,System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Queries whether a stream is selected.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The stream to query. The value can be any of the following.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="fSelectedRef"><dd> <p>Receives <strong>TRUE</strong> if the stream is selected and will generate data. Receives <strong><see cref="F:SharpDX.Result.False"/></strong> if the stream is not selected and will not generate data.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader::GetStreamSelection']/*"/>
|
|
<msdn-id>dd374664</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReader::GetStreamSelection([In] unsigned int dwStreamIndex,[Out] BOOL* pfSelected)</unmanaged>
|
|
<unmanaged-short>IMFSourceReader::GetStreamSelection</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.SetStreamSelection(System.Int32,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Selects or deselects one or more streams.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The stream to set. The value can be any of the following.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.AllStreams"/></strong></strong></dt> <dt>0xFFFFFFFE</dt> </dl> </td><td> <p>All streams.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="fSelected"><dd> <p>Specify <strong>TRUE</strong> to select streams or <strong><see cref="F:SharpDX.Result.False"/></strong> to deselect streams. If a stream is deselected, it will not generate data.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>There are two common uses for this method:</p><ul> <li>To change the default stream selection. Some media files contain multiple streams of the same type. For example, a file might include audio streams for multiple languages. You can use this method to change which of the streams is selected. To get information about each stream, call <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.GetPresentationAttribute(System.Int32,System.Guid,SharpDX.Win32.Variant@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.GetNativeMediaType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType@)"/></strong>.</li> <li>If you will not need data from one of the streams, it is a good idea to deselect that stream. If the stream is selected, the media source might hold onto a queue of unread data, and the queue might grow indefinitely, consuming memory. </li> </ul><p>For an example of deselecting a stream, see Tutorial: Decoding Audio.</p><p>If a stream is deselected, the <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.ReadSample(System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int64@,SharpDX.MediaFoundation.Sample@)"/></strong> method returns <strong>MF_E_INVALIDREQUEST</strong> for that stream. Other <strong><see cref="T:SharpDX.MediaFoundation.SourceReader"/></strong> methods are valid for deselected streams.</p><p>Stream selection does not affect how the source reader loads or unloads decoders in memory. In particular, deselecting a stream does not force the source reader to unload the decoder for that stream.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader::SetStreamSelection']/*"/>
|
|
<msdn-id>dd374669</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReader::SetStreamSelection([In] unsigned int dwStreamIndex,[In] BOOL fSelected)</unmanaged>
|
|
<unmanaged-short>IMFSourceReader::SetStreamSelection</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.GetNativeMediaType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets a format that is supported natively by the media source.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>Specifies which stream to query. The value can be any of the following.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="dwMediaTypeIndex"><dd> <p>The zero-based index of the media type to retrieve.</p> </dd></param>
|
|
<param name="mediaTypeOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDSTREAMNUMBER</strong></strong></dt> </dl> </td><td> <p>The <em>dwStreamIndex</em> parameter is invalid.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_NO_MORE_TYPES</strong></strong></dt> </dl> </td><td> <p>The <em>dwMediaTypeIndex</em> parameter is out of range.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method queries the underlying media source for its native output format. Potentially, each source stream can produce more than one output format. Use the <em>dwMediaTypeIndex</em> parameter to loop through the available formats. Generally, file sources offer just one format per stream, but capture devices might offer several formats.</p><p> The method returns a copy of the media type, so it is safe to modify the object received in the <em> ppMediaType</em> parameter.</p><p>To set the output type for a stream, call the <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.SetCurrentMediaType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType)"/></strong> method.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader::GetNativeMediaType']/*"/>
|
|
<msdn-id>dd374661</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReader::GetNativeMediaType([In] unsigned int dwStreamIndex,[In] unsigned int dwMediaTypeIndex,[Out] IMFMediaType** ppMediaType)</unmanaged>
|
|
<unmanaged-short>IMFSourceReader::GetNativeMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.GetCurrentMediaType(System.Int32,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the current media type for a stream.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The stream to query. The value can be any of the following.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="mediaTypeOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDSTREAMNUMBER</strong></strong></dt> </dl> </td><td> <p>The <em>dwStreamIndex</em> parameter is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader::GetCurrentMediaType']/*"/>
|
|
<msdn-id>dd374660</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReader::GetCurrentMediaType([In] unsigned int dwStreamIndex,[Out] IMFMediaType** ppMediaType)</unmanaged>
|
|
<unmanaged-short>IMFSourceReader::GetCurrentMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.SetCurrentMediaType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Sets the media type for a stream.</p><p>This media type defines that format that the Source Reader produces as output. It can differ from the native format provided by the media source. See Remarks for more information.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex">No documentation.</param>
|
|
<param name="dwReservedRef">No documentation.</param>
|
|
<param name="mediaTypeRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDMEDIATYPE</strong></strong></dt> </dl> </td><td> <p>At least one decoder was found for the native stream type, but the type specified by <em>pMediaType</em> was rejected.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>One or more sample requests are still pending.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDSTREAMNUMBER</strong></strong></dt> </dl> </td><td> <p>The <em>dwStreamIndex</em> parameter is invalid.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_TOPO_CODEC_NOT_FOUND</strong></strong></dt> </dl> </td><td> <p>Could not find a decoder for the native stream type.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>For each stream, you can set the media type to any of the following:</p><ul> <li>One of the native types offered by the media source. To enumerate the native types, call <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.GetNativeMediaType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType@)"/></strong>.</li> <li>If the native media type is compressed, you can specify a corresponding uncompressed format. The Source Reader will search for a decoder that can decode from the native format to the specified uncompressed format.</li> </ul><p>The source reader does not support audio resampling. If you need to resample the audio, you can use the <strong>Audio Resampler DSP</strong>.</p><p>If you set the <see cref="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.EnableVideoProcessing"/> attribute to <strong>TRUE</strong> when you create the Source Reader, the Source Reader will convert YUV video to RGB-32. This conversion is not optimized for real-time video playback.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader::SetCurrentMediaType']/*"/>
|
|
<msdn-id>dd374667</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReader::SetCurrentMediaType([In] unsigned int dwStreamIndex,[In] unsigned int* pdwReserved,[In] IMFMediaType* pMediaType)</unmanaged>
|
|
<unmanaged-short>IMFSourceReader::SetCurrentMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.SetCurrentPosition(System.Guid,SharpDX.Win32.Variant)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Seeks to a new position in the media source.</p>
|
|
</summary>
|
|
<param name="guidTimeFormat"><dd> <p>A <see cref="T:System.Guid"/> that specifies the <em>time format</em>. The time format defines the units for the <em>varPosition</em> parameter. The following value is defined for all media sources:</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>GUID_NULL</strong></dt> </dl> </td><td> <p>100-nanosecond units.</p> </td></tr> </table> <p>?</p> <p>Some media sources might support additional values. </p> </dd></param>
|
|
<param name="varPosition"><dd> <p>The position from which playback will be started. The units are specified by the <em>guidTimeFormat</em> parameter. If the <em>guidTimeFormat</em> parameter is <strong>GUID_NULL</strong>, set the variant type to <strong>VT_I8</strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>One or more sample requests are still pending.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <strong>SetCurrentPosition</strong> method does not guarantee exact seeking. The accuracy of the seek depends on the media content. If the media content contains a video stream, the <strong>SetCurrentPosition</strong> method typically seeks to the nearest key frame before the desired position. The distance between key frames depends on several factors, including the encoder implementation, the video content, and the particular encoding settings used to encode the content. The distance between key frame can vary within a single video file (for example, depending on scene complexity).</p><p>After seeking, the application should call <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.ReadSample(System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int64@,SharpDX.MediaFoundation.Sample@)"/></strong> and advance to the desired position. </p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader::SetCurrentPosition']/*"/>
|
|
<msdn-id>dd374668</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReader::SetCurrentPosition([In] const GUID& guidTimeFormat,[In] const PROPVARIANT& varPosition)</unmanaged>
|
|
<unmanaged-short>IMFSourceReader::SetCurrentPosition</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.ReadSample(System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int64@,SharpDX.MediaFoundation.Sample@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Reads the next sample from the media source.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The stream to pull data from. The value can be any of the following.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.AnyStream"/></strong></strong></dt> <dt>0xFFFFFFFE</dt> </dl> </td><td> <p>Get the next available sample, regardless of which stream.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="dwControlFlags"><dd> <p>A bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.SourceReaderControlFlags"/></strong> enumeration.</p> </dd></param>
|
|
<param name="dwActualStreamIndexRef"><dd> <p>Receives the zero-based index of the stream.</p> </dd></param>
|
|
<param name="dwStreamFlagsRef"><dd> <p>Receives a bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.SourceReaderFlags"/></strong> enumeration.</p> </dd></param>
|
|
<param name="llTimestampRef"><dd> <p>Receives the time stamp of the sample, or the time of the stream event indicated in <em>pdwStreamFlags</em>. The time is given in 100-nanosecond units.</p> </dd></param>
|
|
<param name="sampleOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface or the value <strong><c>null</c></strong> (see Remarks). If this parameter receives a non-<strong><c>null</c></strong> reference, the caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDREQUEST</strong></strong></dt> </dl> </td><td> <p>Invalid request.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDSTREAMNUMBER</strong></strong></dt> </dl> </td><td> <p>The <em>dwStreamIndex</em> parameter is invalid.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_NOTACCEPTING</strong></strong></dt> </dl> </td><td> <p>A flush operation is pending. See <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.Flush(System.Int32)"/></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>E_INVALIDARG</strong></strong></dt> </dl> </td><td> <p>Invalid argument. See Remarks.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the requested stream is not selected, the return code is <strong>MF_E_INVALIDREQUEST</strong>. See <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.SetStreamSelection(System.Int32,System.Boolean)"/></strong>.</p><p> This method can complete synchronously or asynchronously. If you provide a callback reference when you create the source reader, the method is asynchronous. Otherwise, the method is synchronous. For more information about setting the callback reference, see <see cref="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.AsyncCallback"/>.</p>Asynchronous Mode<p>In asynchronous mode:</p><ul> <li>All of the <code>[out]</code> parameters must be <strong><c>null</c></strong>. Otherwise, the method returns <strong>E_INVALIDARG</strong>.</li> <li>The method returns immediately.</li> <li>When the operation completes, the application's <strong><see cref="M:SharpDX.MediaFoundation.SourceReaderCallback.OnReadSample(SharpDX.Result,System.Int32,System.Int32,System.Int64,SharpDX.MediaFoundation.Sample)"/></strong> method is called.</li> <li>If an error occurs, the method can fail either synchronously or asynchronously. Check the return value of <strong>ReadSample</strong>, and also check the <em>hrStatus</em> parameter of <strong><see cref="M:SharpDX.MediaFoundation.SourceReaderCallback.OnReadSample(SharpDX.Result,System.Int32,System.Int32,System.Int64,SharpDX.MediaFoundation.Sample)"/></strong>.</li> </ul>Synchronous Mode<p>In synchronous mode:</p><ul> <li>The <em>pdwStreamFlags</em> and <em>ppSample</em> parameters cannot be <strong><c>null</c></strong>. Otherwise, the method returns <strong>E_POINTER</strong>.</li> <li>The <em>pdwActualStreamIndex</em> and <em>pllTimestamp</em> parameters can be <strong><c>null</c></strong>.</li> <li>The method blocks until the next sample is available.</li> </ul><p> In synchronous mode, if the <em>dwStreamIndex</em> parameter is <strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.AnyStream"/></strong>, you should pass a non-<strong><c>null</c></strong> value for <em>pdwActualStreamIndex</em>, so that you know which stream delivered the sample.</p><p>This method can return flags in the <em>pdwStreamFlags</em> parameter without returning a media sample in <em>ppSample</em>. Therefore, the <em>ppSample</em> parameter can receive a <strong><c>null</c></strong> reference even when the method succeeds. For example, when the source reader reaches the end of the stream, it returns the <strong><see cref="F:SharpDX.MediaFoundation.SourceReaderFlags.FEndofstream"/></strong> flag in <em>pdwStreamFlags</em> and sets <em>ppSample</em> to <strong><c>null</c></strong>.</p><p>If there is a gap in the stream, <em>pdwStreamFlags</em> receives the <see cref="F:SharpDX.MediaFoundation.SourceReaderFlags.FStreamtick"/> flag, <em>ppSample</em> is <strong><c>null</c></strong>, and <em>pllTimestamp</em> indicates the time when the gap occurred. </p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader::ReadSample']/*"/>
|
|
<msdn-id>dd374665</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReader::ReadSample([In] unsigned int dwStreamIndex,[In] unsigned int dwControlFlags,[Out, Optional] unsigned int* pdwActualStreamIndex,[Out, Optional] unsigned int* pdwStreamFlags,[Out, Optional] longlong* pllTimestamp,[Out, Optional] IMFSample** ppSample)</unmanaged>
|
|
<unmanaged-short>IMFSourceReader::ReadSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.Flush(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Flushes one or more streams.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The stream to flush. The value can be any of the following.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.AllStreams"/></strong></strong></dt> <dt>0xFFFFFFFE</dt> </dl> </td><td> <p>All streams.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The <strong>Flush</strong> method discards all queued samples and cancels all pending sample requests.</p><p>This method can complete either synchronously or asynchronously. If you provide a callback reference when you create the source reader, the method is asynchronous. Otherwise, the method is synchronous. For more information about the setting the callback reference, see <see cref="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.AsyncCallback"/>.</p><p>In synchronous mode, the method blocks until the operation is complete.</p><p>In asynchronous mode, the application's <strong><see cref="M:SharpDX.MediaFoundation.SourceReaderCallback.OnFlush(System.Int32)"/></strong> method is called when the flush operation completes. While a flush operation is pending, the <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.ReadSample(System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int64@,SharpDX.MediaFoundation.Sample@)"/></strong> method returns <strong>MF_E_NOTACCEPTING</strong>.</p><p><strong>Note</strong>??In Windows?7, there was a bug in the implementation of this method, which causes <strong>OnFlush</strong> to be called before the flush operation completes. A hotfix is available that fixes this bug. For more information, see http://support.microsoft.com/kb/979567.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader::Flush']/*"/>
|
|
<msdn-id>dd374659</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReader::Flush([In] unsigned int dwStreamIndex)</unmanaged>
|
|
<unmanaged-short>IMFSourceReader::Flush</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.GetServiceForStream(System.Int32,System.Guid,System.Guid,System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Queries the underlying media source or decoder for an interface.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The stream or object to query. If the value is <strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.Mediasource"/></strong>, the method queries the media source. Otherwise, it queries the decoder that is associated with the specified stream. The following values are possible.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.Mediasource"/></strong></strong></dt> <dt>0xFFFFFFFF</dt> </dl> </td><td> <p>The media source.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="guidService"><dd> <p>A service identifier <see cref="T:System.Guid"/>. If the value is <strong>GUID_NULL</strong>, the method calls <strong>QueryInterface</strong> to get the requested interface. Otherwise, the method calls the <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> method. For a list of service identifiers, see Service Interfaces.</p> </dd></param>
|
|
<param name="riid"><dd> <p>The interface identifier (IID) of the interface being requested. </p> </dd></param>
|
|
<param name="vObjectOut"><dd> <p>Receives a reference to the requested interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader::GetServiceForStream']/*"/>
|
|
<msdn-id>dd374663</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReader::GetServiceForStream([In] unsigned int dwStreamIndex,[In] const GUID& guidService,[In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
|
|
<unmanaged-short>IMFSourceReader::GetServiceForStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReader.GetPresentationAttribute(System.Int32,System.Guid,SharpDX.Win32.Variant@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets an attribute from the underlying media source.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The stream or object to query. The value can be any of the following.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.Mediasource"/></strong></strong></dt> <dt>0xFFFFFFFF</dt> </dl> </td><td> <p>The media source.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="guidAttribute"><dd> <p>A <see cref="T:System.Guid"/> that identifies the attribute to retrieve. If the <em>dwStreamIndex</em> parameter equals <strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.Mediasource"/></strong>, <em>guidAttribute</em> can specify one of the following:</p> <ul> <li>A presentation descriptor attribute. For a list of values, see Presentation Descriptor Attributes.</li> <li> <see cref="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.MediaSourceCharacteristics"/>. Use this value to get characteristics flags from the media source.</li> </ul> <p>Otherwise, if the <em>dwStreamIndex</em> parameter specifies a stream, <em>guidAttribute</em> specifies a stream descriptor attribute. For a list of values, see Stream Descriptor Attributes.</p> </dd></param>
|
|
<param name="varAttributeRef"><dd> <p>A reference to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that receives the value of the attribute. Call the <strong>PropVariantClear</strong> function to free the <strong><see cref="T:SharpDX.Win32.Variant"/></strong>. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReader::GetPresentationAttribute']/*"/>
|
|
<msdn-id>dd374662</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReader::GetPresentationAttribute([In] unsigned int dwStreamIndex,[In] const GUID& guidAttribute,[Out] PROPVARIANT* pvarAttribute)</unmanaged>
|
|
<unmanaged-short>IMFSourceReader::GetPresentationAttribute</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SourceReaderCallback">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Callback interface for the Microsoft Media Foundation source reader.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Use the <see cref="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.AsyncCallback"/> attribute to set the callback reference when you first create the source reader object.</p><p>The callback methods can be called from any thread, so an object that implements this interface must be thread-safe.</p><p>If you do not specify a callback reference, the source reader operates synchronously.</p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReaderCallback']/*"/>
|
|
<msdn-id>dd374656</msdn-id>
|
|
<unmanaged>IMFSourceReaderCallback</unmanaged>
|
|
<unmanaged-short>IMFSourceReaderCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReaderCallback.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SourceReaderCallback"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReaderCallback.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SourceReaderCallback">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SourceReaderCallback"/>. (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.MediaFoundation.SourceReaderCallback.OnReadSample(SharpDX.Result,System.Int32,System.Int32,System.Int64,SharpDX.MediaFoundation.Sample)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Called when the <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.ReadSample(System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int64@,SharpDX.MediaFoundation.Sample@)"/></strong> method completes.</p>
|
|
</summary>
|
|
<param name="hrStatus">No documentation.</param>
|
|
<param name="dwStreamIndex">No documentation.</param>
|
|
<param name="dwStreamFlags">No documentation.</param>
|
|
<param name="llTimestamp">No documentation.</param>
|
|
<param name="sampleRef">No documentation.</param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Currently, the source reader ignores the return value.</p></returns>
|
|
<remarks>
|
|
<p>The <em>pSample</em> parameter might be <strong><c>null</c></strong>. For example, when the source reader reaches the end of a stream, <em>dwStreamFlags</em> contains the <strong><see cref="F:SharpDX.MediaFoundation.SourceReaderFlags.FEndofstream"/></strong> flag, and <em>pSample</em> is <strong><c>null</c></strong>. </p><p>If there is a gap in the stream, <em>dwStreamFlags</em> contains the <strong><see cref="F:SharpDX.MediaFoundation.SourceReaderFlags.FStreamtick"/></strong> flag, <em>pSample</em> is <strong><c>null</c></strong>, and <em>llTimestamp</em> indicates the time when the gap occurred. </p><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReaderCallback::OnReadSample']/*"/>
|
|
<msdn-id>dd374658</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReaderCallback::OnReadSample([In] HRESULT hrStatus,[In] unsigned int dwStreamIndex,[In] unsigned int dwStreamFlags,[In] longlong llTimestamp,[In, Optional] IMFSample* pSample)</unmanaged>
|
|
<unmanaged-short>IMFSourceReaderCallback::OnReadSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReaderCallback.OnFlush(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Called when the <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.Flush(System.Int32)"/></strong> method completes.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex">No documentation.</param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Currently, the source reader ignores the return value.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReaderCallback::OnFlush']/*"/>
|
|
<msdn-id>dd374657</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReaderCallback::OnFlush([In] unsigned int dwStreamIndex)</unmanaged>
|
|
<unmanaged-short>IMFSourceReaderCallback::OnFlush</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReaderCallback.OnEvent(System.Int32,SharpDX.MediaFoundation.MediaEvent)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Called when the source reader receives certain events from the media source.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>For stream events, the value is the zero-based index of the stream that sent the event. For source events, the value is <strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.Mediasource"/></strong>.</p> </dd></param>
|
|
<param name="eventRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaEvent"/></strong> interface of the event.</p> </dd></param>
|
|
<returns><p>Returns an <strong><see cref="T:SharpDX.Result"/></strong> value. Currently, the source reader ignores the return value.</p></returns>
|
|
<remarks>
|
|
<p>In the current implementation, the source reader uses this method to forward the following events to the application:</p><ul> <li> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStarted"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.BufferingStopped"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.ConnectEnd"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.ConnectStart"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.ExtendedType"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceCharacteristicsChanged"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SourceMetadataChanged"/> </li> </ul><p>This interface is available on Windows?Vista if Platform Update Supplement for Windows?Vista is installed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReaderCallback::OnEvent']/*"/>
|
|
<msdn-id>dd743367</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReaderCallback::OnEvent([In] unsigned int dwStreamIndex,[In] IMFMediaEvent* pEvent)</unmanaged>
|
|
<unmanaged-short>IMFSourceReaderCallback::OnEvent</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SourceReaderEx">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Extends the <strong><see cref="T:SharpDX.MediaFoundation.SourceReader"/></strong> interface.</p><p>The Source Reader implements this interface in Windows?8 Consumer Preview. To get a reference to this interface, call <strong>QueryInterface</strong> on the Source Reader.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReaderEx']/*"/>
|
|
<msdn-id>hh448062</msdn-id>
|
|
<unmanaged>IMFSourceReaderEx</unmanaged>
|
|
<unmanaged-short>IMFSourceReaderEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReaderEx.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SourceReaderEx"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReaderEx.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SourceReaderEx">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SourceReaderEx"/>. (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.MediaFoundation.SourceReaderEx.SetNativeMediaType(System.Int32,SharpDX.MediaFoundation.MediaType,System.Int32@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Sets the native media type for a stream on the media source.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd></dd></param>
|
|
<param name="mediaTypeRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type.</p> </dd></param>
|
|
<param name="dwStreamFlagsRef"><dd> <p>Receives a bitwise <strong>OR</strong> of zero or more of the following flags.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderFlags.FAlleffectsremoved"/></strong></dt> </dl> </td><td> <p>All effects were removed from the stream.</p> </td></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderFlags.FCurrentmediatypechanged"/></strong></dt> </dl> </td><td> <p>The current output type changed.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Invalid request.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDSTREAMNUMBER</strong></strong></dt> </dl> </td><td> <p>The <em>dwStreamIndex</em> parameter is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method sets the output type that is produced by the media source. Unlike the <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.SetCurrentMediaType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType)"/></strong> method, this method does not insert any decoders, video processors, or other transforms. The media source must support the specified media type natively. To get a list of supported types from the media source, call <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.GetNativeMediaType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType@)"/></strong>.</p><p>In asynchronous mode, this method fails if a sample request is pending. In that case, wait for the <strong>OnReadSample</strong> callback to be invoked before calling the method. For more information about using the Source Reader in asynchronous mode, see <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.ReadSample(System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int64@,SharpDX.MediaFoundation.Sample@)"/></strong>.</p><p>This method can trigger a change in the output format for the stream. If so, the <strong><see cref="F:SharpDX.MediaFoundation.SourceReaderFlags.FCurrentmediatypechanged"/></strong> flag is returned in the <em>pdwStreamFlags</em> parameter. The method might also cause the Source Reader to remove any effects that were added by the <strong><see cref="M:SharpDX.MediaFoundation.SourceReaderEx.AddTransformForStream(System.Int32,SharpDX.ComObject)"/></strong> method. If this occurs, the <strong><see cref="F:SharpDX.MediaFoundation.SourceReaderFlags.FAlleffectsremoved"/></strong> flag is returned in <em>pdwStreamFlags</em>. </p><p>This method is useful with audio and video capture devices, because a device might support several output formats. This method enables the application to choose the device format before decoders and other transforms are added.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReaderEx::SetNativeMediaType']/*"/>
|
|
<msdn-id>hh448066</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReaderEx::SetNativeMediaType([In] unsigned int dwStreamIndex,[In, Optional] IMFMediaType* pMediaType,[Out] unsigned int* pdwStreamFlags)</unmanaged>
|
|
<unmanaged-short>IMFSourceReaderEx::SetNativeMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReaderEx.AddTransformForStream(System.Int32,SharpDX.ComObject)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Adds a transform, such as an audio or video effect, to a stream.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The stream to configure. The value can be any of the following.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="transformOrActivateRef"><dd> <p>A reference to one of the following:</p> <ul> <li>A Media Foundation transform (MFT) that exposes the <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> interface.</li> <li>An MFT activation object that exposes the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface.</li> </ul> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDMEDIATYPE</strong></dt> </dl> </td><td> <p>The transform does not support the current stream format, and no conversion was possible. See Remarks for more information.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Invalid request.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDSTREAMNUMBER</strong></strong></dt> </dl> </td><td> <p>The <em>dwStreamIndex</em> parameter is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method attempts to add the transform at the end of the current processing chain. </p><p>To use this method, make the following sequence of calls:</p><ol> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.SetCurrentMediaType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType)"/></strong> to set the output type that you want for the stream. In this step, you can specify a media type that contains only the major type and subtype GUIDs. For example, to get 32-bit RGB output, set a major type of <strong>MFMediaType_Video</strong> and a subtype of <strong>MFVideoFormat_RGB32</strong>. (For more information, see Media Type GUIDs.)</li> <li>Call <strong>AddTransformForStream</strong>. If the Source Reader successfully connects the transform, it sets the output type on the transform.</li> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.GetCurrentMediaType(System.Int32,SharpDX.MediaFoundation.MediaType@)"/></strong> to get the output type from the transform. This method returns a media type with a complete format description.</li> <li>Optionally, if you want to modify the output type, call <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.SetCurrentMediaType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType)"/></strong> again to set a complete media type on the transform.</li> </ol><p>The <strong>AddTransformForStream</strong> method will not insert a decoder into the processing chain. If the native stream format is encoded, and the transform requires an uncompressed format, call <strong>SetCurrentMediaType</strong> to set the uncompressed format (step 1 in the previous list). However, the method will insert a video processor to convert between RGB and YUV formats, if required.</p><p>The method fails if the source reader was configured with the <see cref="F:SharpDX.MediaFoundation.SinkWriterAttributeKeys.ReadwriteDisableConverters"/> or <see cref="F:SharpDX.MediaFoundation.SourceReaderAttributeKeys.EnableVideoProcessing"/> attributes. </p><p>In asynchronous mode, the method also fails if a sample request is pending. In that case, wait for the <strong>OnReadSample</strong> callback to be invoked before calling the method. For more information about using the Source Reader in asynchronous mode, see <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.ReadSample(System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int64@,SharpDX.MediaFoundation.Sample@)"/></strong>.</p><p>You can add a transform at any time during streaming. However, the method does not flush or drain the pipeline before inserting the transform. Therefore, if data is already in the pipeline, the next sample is not guaranteed to have the transform applied.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReaderEx::AddTransformForStream']/*"/>
|
|
<msdn-id>hh448063</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReaderEx::AddTransformForStream([In] unsigned int dwStreamIndex,[In] IUnknown* pTransformOrActivate)</unmanaged>
|
|
<unmanaged-short>IMFSourceReaderEx::AddTransformForStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReaderEx.RemoveAllTransformsForStream(System.Int32)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Removes all of the Media Foundation transforms (MFTs) for a specified stream, with the exception of the decoder.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The stream for which to remove the MFTs. The value can be any of the following.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Invalid request.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDSTREAMNUMBER</strong></strong></dt> </dl> </td><td> <p>The <em>dwStreamIndex</em> parameter is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Calling this method can reset the current output type for the stream. To get the new output type, call <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.GetCurrentMediaType(System.Int32,SharpDX.MediaFoundation.MediaType@)"/></strong>.</p><p>In asynchronous mode, this method fails if a sample request is pending. In that case, wait for the <strong>OnReadSample</strong> callback to be invoked before calling the method. For more information about using the Source Reader in asynchronous mode, see <strong><see cref="M:SharpDX.MediaFoundation.SourceReader.ReadSample(System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int64@,SharpDX.MediaFoundation.Sample@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReaderEx::RemoveAllTransformsForStream']/*"/>
|
|
<msdn-id>hh448065</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReaderEx::RemoveAllTransformsForStream([In] unsigned int dwStreamIndex)</unmanaged>
|
|
<unmanaged-short>IMFSourceReaderEx::RemoveAllTransformsForStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceReaderEx.GetTransformForStream(System.Int32,System.Int32,System.Guid@,SharpDX.MediaFoundation.Transform@)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets a reference to a Media Foundation transform (MFT) for a specified stream.</p>
|
|
</summary>
|
|
<param name="dwStreamIndex"><dd> <p>The stream to query for the MFT. The value can be any of the following.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td> <dl> <dt>0?0xFFFFFFFB</dt> </dl> </td><td> <p>The zero-based index of a stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstVideoStream"/></strong></strong></dt> <dt>0xFFFFFFFC</dt> </dl> </td><td> <p>The first video stream.</p> </td></tr> <tr><td><dl> <dt><strong><strong><see cref="F:SharpDX.MediaFoundation.SourceReaderIndex.FirstAudioStream"/></strong></strong></dt> <dt>0xFFFFFFFD</dt> </dl> </td><td> <p>The first audio stream.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="dwTransformIndex"><dd> <p>The zero-based index of the MFT to retreive.</p> </dd></param>
|
|
<param name="guidCategoryRef"><dd> <p>Receives a <see cref="T:System.Guid"/> that specifies the category of the MFT. For a list of possible values, see <strong>MFT_CATEGORY</strong>.</p> </dd></param>
|
|
<param name="transformOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> interface of the MFT. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>This method can return one of these values.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>Success.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDINDEX</strong></dt> </dl> </td><td> <p>The <em>dwTransformIndex</em> parameter is out of range.</p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_INVALIDSTREAMNUMBER</strong></strong></dt> </dl> </td><td> <p>The <em>dwStreamIndex</em> parameter is invalid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You can use this method to configure an MFT after it is inserted into the processing chain. Do not use the reference returned in <em>ppTransform</em> to set media types on the MFT or to process data. In particular, calling any of the following <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> methods could have unexpected results.</p><ul> <li> <strong>AddInputStreams</strong> </li> <li> <strong>DeleteInputStream</strong> </li> <li> <strong>ProcessEvent</strong> </li> <li> <strong>ProcessInput</strong> </li> <li> <strong>ProcessMessage</strong> </li> <li> <strong>ProcessOutput</strong> </li> <li> <strong>SetInputType</strong> </li> <li> <strong>SetOutputType</strong> </li> </ul><p>If a decoder is present, it appears at index position zero.</p><p>To avoid losing any data, you should drain the source reader before calling this method. For more information, see Draining the Data Pipeline.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceReaderEx::GetTransformForStream']/*"/>
|
|
<msdn-id>hh448064</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceReaderEx::GetTransformForStream([In] unsigned int dwStreamIndex,[In] unsigned int dwTransformIndex,[Out, Optional] GUID* pGuidCategory,[Out] IMFTransform** ppTransform)</unmanaged>
|
|
<unmanaged-short>IMFSourceReaderEx::GetTransformForStream</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SourceResolver">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates a media source or a byte stream from a URL. This method is synchronous. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The <em>dwFlags</em> parameter must contain either the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong> flag or the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong> flag, but should not contain both.</p><p>For local files, you can pass the file name in the <em>pwszURL</em> parameter; the <code>file:</code> scheme is not required.</p><p><strong>Note</strong>??This method cannot be called remotely.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceResolver']/*"/>
|
|
<msdn-id>ms702279</msdn-id>
|
|
<unmanaged>IMFSourceResolver</unmanaged>
|
|
<unmanaged-short>IMFSourceResolver</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceResolver.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SourceResolver"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceResolver.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SourceResolver">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SourceResolver"/>. (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.MediaFoundation.SourceResolver.CreateObjectFromURL(System.String,System.Int32,SharpDX.ComObject,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates a media source or a byte stream from a URL. This method is synchronous. </p>
|
|
</summary>
|
|
<param name="wszURLRef"><dd> <p> Null-terminated string that contains the URL to resolve. </p> </dd></param>
|
|
<param name="dwFlags"><dd> <p> Bitwise OR of one or more flags. See <strong>Source Resolver Flags</strong>. </p> </dd></param>
|
|
<param name="propsRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a property store. The method passes the property store to the scheme handler or byte-stream handler that creates the object. The handler can use the property store to configure the object. This parameter can be <strong><c>null</c></strong>. For more information, see Configuring a Media Source. </p> </dd></param>
|
|
<param name="objectTypeRef"><dd> <p> Receives a member of the <strong><see cref="T:SharpDX.MediaFoundation.ObjectType"/></strong> enumeration, specifying the type of object that was created. </p> </dd></param>
|
|
<param name="objectOut"><dd> <p> Receives a reference to the object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SOURCERESOLVER_MUTUALLY_EXCLUSIVE_FLAGS</strong></dt> </dl> </td><td> <p> The <em>dwFlags</em> parameter contains mutually exclusive flags. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_SCHEME</strong></dt> </dl> </td><td> <p> The URL scheme is not supported. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <em>dwFlags</em> parameter must contain either the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong> flag or the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong> flag, but should not contain both.</p><p>For local files, you can pass the file name in the <em>pwszURL</em> parameter; the <code>file:</code> scheme is not required.</p><p><strong>Note</strong>??This method cannot be called remotely.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceResolver::CreateObjectFromURL']/*"/>
|
|
<msdn-id>ms702279</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceResolver::CreateObjectFromURL([In] const wchar_t* pwszURL,[In] unsigned int dwFlags,[In] IPropertyStore* pProps,[Out] MF_OBJECT_TYPE* pObjectType,[Out] IUnknown** ppObject)</unmanaged>
|
|
<unmanaged-short>IMFSourceResolver::CreateObjectFromURL</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceResolver.CreateObjectFromByteStream(SharpDX.MediaFoundation.ByteStream,System.String,System.Int32,SharpDX.ComObject,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Creates a media source from a byte stream. This method is synchronous. </p>
|
|
</summary>
|
|
<param name="byteStreamRef"><dd> <p> Pointer to the byte stream's <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface. </p> </dd></param>
|
|
<param name="wszURLRef"><dd> <p> Null-terminated string that contains the URL of the byte stream. The URL is optional and can be <strong><c>null</c></strong>. See Remarks for more information. </p> </dd></param>
|
|
<param name="dwFlags"><dd> <p> Bitwise <strong>OR</strong> of flags. See <strong>Source Resolver Flags</strong>. </p> </dd></param>
|
|
<param name="propsRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a property store. The method passes the property store to the byte-stream handler. The byte-stream handler can use the property store to configure the media source. This parameter can be <strong><c>null</c></strong>. For more information, see Configuring a Media Source. </p> </dd></param>
|
|
<param name="objectTypeRef"><dd> <p> Receives a member of the <strong><see cref="T:SharpDX.MediaFoundation.ObjectType"/></strong> enumeration, specifying the type of object that was created. </p> </dd></param>
|
|
<param name="objectOut"><dd> <p> Receives a reference to the media source's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SOURCERESOLVER_MUTUALLY_EXCLUSIVE_FLAGS</strong></dt> </dl> </td><td> <p> The <em>dwFlags</em> parameter contains mutually exclusive flags. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_BYTESTREAM_TYPE</strong></dt> </dl> </td><td> <p> This byte stream is not supported. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <em>dwFlags</em> parameter must contain the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong> flag and should not contain the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong> flag.</p><p>The source resolver attempts to find one or more byte-stream handlers for the byte stream, based on the file name extension of the URL, or the MIME type of the byte stream (or both). The URL is specified in the optional <em>pwszURL</em> parameter, and the MIME type may be specified in the <strong><see cref="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.ContentType"/></strong> attribute on the byte stream. Byte-stream handlers are registered by file name extension or MIME type, or both, as described in Scheme Handlers and Byte-Stream Handlers. The caller should specify at least one of these values (both if possible):</p><ul> <li> Specify the URL in the <em>pwszURL</em> parameter. </li> <li> Specify the MIME type by setting the <strong><see cref="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.ContentType"/></strong> attribute on the byte stream. (This attribute might be set already when you create the byte stream, depending on how the byte stream was created.) </li> </ul><p><strong>Note</strong>??This method cannot be called remotely.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceResolver::CreateObjectFromByteStream']/*"/>
|
|
<msdn-id>ms704671</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceResolver::CreateObjectFromByteStream([In] IMFByteStream* pByteStream,[In] const wchar_t* pwszURL,[In] unsigned int dwFlags,[In] IPropertyStore* pProps,[Out] MF_OBJECT_TYPE* pObjectType,[Out] IUnknown** ppObject)</unmanaged>
|
|
<unmanaged-short>IMFSourceResolver::CreateObjectFromByteStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceResolver.BeginCreateObjectFromURL(System.String,System.Int32,SharpDX.ComObject,SharpDX.ComObject@,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Begins an asynchronous request to create a media source or a byte stream from a URL.</p>
|
|
</summary>
|
|
<param name="wszURLRef"><dd> <p>Null-terminated string that contains the URL to resolve.</p> </dd></param>
|
|
<param name="dwFlags"><dd> <p>Bitwise OR of flags. See <strong>Source Resolver Flags</strong>.</p> </dd></param>
|
|
<param name="propsRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a property store. The method passes the property store to the scheme handler or byte-stream handler that creates the object. The handler can use the property store to configure the object. This parameter can be <strong><c>null</c></strong>. For more information, see Configuring a Media Source.</p> </dd></param>
|
|
<param name="iUnknownCancelCookieOut"><dd> <p>Receives an <strong><see cref="T:SharpDX.ComObject"/></strong> reference or the value <strong><c>null</c></strong>. If the value is not <strong><c>null</c></strong>, you can cancel the asynchronous operation by passing this reference to the <strong><see cref="M:SharpDX.MediaFoundation.SourceResolver.CancelObjectCreation(SharpDX.ComObject)"/></strong> method. The caller must release the interface. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface.</p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SOURCERESOLVER_MUTUALLY_EXCLUSIVE_FLAGS</strong></dt> </dl> </td><td> <p>The <em>dwFlags</em> parameter contains mutually exclusive flags.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_SCHEME</strong></dt> </dl> </td><td> <p>The URL scheme is not supported.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <em>dwFlags</em> parameter must contain either the <see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/> flag or the <see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/> flag, but should not contain both.</p><p>For local files, you can pass the file name in the <em>pwszURL</em> parameter; the <code>file:</code> scheme is not required.</p><p>When the operation completes, the source resolver calls the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. The <strong>Invoke</strong> method should call <strong><see cref="M:SharpDX.MediaFoundation.SourceResolver.EndCreateObjectFromURL(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong> to get a reference to the object that was created.</p><p>The usage of the <em>pProps</em> parameter depends on the implementation of the media source. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceResolver::BeginCreateObjectFromURL']/*"/>
|
|
<msdn-id>ms702995</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceResolver::BeginCreateObjectFromURL([In] const wchar_t* pwszURL,[In] unsigned int dwFlags,[In] IPropertyStore* pProps,[Out, Optional] IUnknown** ppIUnknownCancelCookie,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFSourceResolver::BeginCreateObjectFromURL</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceResolver.EndCreateObjectFromURL(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Completes an asynchronous request to create an object from a URL. </p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong>Invoke</strong> method. </p> </dd></param>
|
|
<param name="objectTypeRef"><dd> <p> Receives a member of the <strong><see cref="T:SharpDX.MediaFoundation.ObjectType"/></strong> enumeration, specifying the type of object that was created. </p> </dd></param>
|
|
<param name="objectOut"><dd> <p> Receives a reference to the media source's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_ABORT</strong></dt> </dl> </td><td> <p> The operation was canceled. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method from inside your application's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceResolver::EndCreateObjectFromURL']/*"/>
|
|
<msdn-id>ms702134</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceResolver::EndCreateObjectFromURL([In] IMFAsyncResult* pResult,[Out] MF_OBJECT_TYPE* pObjectType,[Out] IUnknown** ppObject)</unmanaged>
|
|
<unmanaged-short>IMFSourceResolver::EndCreateObjectFromURL</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceResolver.BeginCreateObjectFromByteStream(SharpDX.MediaFoundation.ByteStream,System.String,System.Int32,SharpDX.ComObject,SharpDX.ComObject@,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Begins an asynchronous request to create a media source from a byte stream.</p>
|
|
</summary>
|
|
<param name="byteStreamRef"><dd> <p>A reference to the byte stream's <strong><see cref="T:SharpDX.MediaFoundation.ByteStream"/></strong> interface. </p> </dd></param>
|
|
<param name="wszURLRef"><dd> <p>A null-terminated string that contains the original URL of the byte stream. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="dwFlags"><dd> <p>A bitwise <strong>OR</strong> of one or more flags. See <strong>Source Resolver Flags</strong>. </p> </dd></param>
|
|
<param name="propsRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a property store. The method passes the property store to the byte-stream handler. The byte-stream handler can use the property store to configure the media source. This parameter can be <strong><c>null</c></strong>. For more information, see Configuring a Media Source. </p> </dd></param>
|
|
<param name="iUnknownCancelCookieOut"><dd> <p>Receives an <strong><see cref="T:SharpDX.ComObject"/></strong> reference or the value <strong><c>null</c></strong>. If the value is not <strong><c>null</c></strong>, you can cancel the asynchronous operation by passing this reference to the <strong><see cref="M:SharpDX.MediaFoundation.SourceResolver.CancelObjectCreation(SharpDX.ComObject)"/></strong> method. The caller must release the interface. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface. </p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>A oointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SOURCERESOLVER_MUTUALLY_EXCLUSIVE_FLAGS</strong></dt> </dl> </td><td> <p>The <em>dwFlags</em> parameter contains mutually exclusive flags.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_BYTESTREAM_TYPE</strong></dt> </dl> </td><td> <p>The byte stream is not supported.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BYTESTREAM_NOT_SEEKABLE</strong></dt> </dl> </td><td> <p>The byte stream does not support seeking.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The <em>dwFlags</em> parameter must contain the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Mediasource"/></strong> flag and should not contain the <strong><see cref="F:SharpDX.MediaFoundation.SourceResolverFlags.Bytestream"/></strong> flag.</p><p>The source resolver attempts to find one or more byte-stream handlers for the byte stream, based on the file name extension of the URL, or the MIME type of the byte stream (or both). The URL is specified in the optional <em>pwszURL</em> parameter, and the MIME type may be specified in the <strong><see cref="F:SharpDX.MediaFoundation.ByteStreamAttributeKeys.ContentType"/></strong> attribute on the byte stream. Byte-stream handlers are registered by file name extension or MIME type, or both, as described in Scheme Handlers and Byte-Stream Handlers. The caller should specify at least one of these values.</p><p>When the operation completes, the source resolver calls the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. The <strong>Invoke</strong> method should call <strong><see cref="M:SharpDX.MediaFoundation.SourceResolver.EndCreateObjectFromByteStream(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)"/></strong> to get a reference to the media source.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceResolver::BeginCreateObjectFromByteStream']/*"/>
|
|
<msdn-id>ms698915</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceResolver::BeginCreateObjectFromByteStream([In] IMFByteStream* pByteStream,[In] const wchar_t* pwszURL,[In] unsigned int dwFlags,[In] IPropertyStore* pProps,[Out, Optional] IUnknown** ppIUnknownCancelCookie,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFSourceResolver::BeginCreateObjectFromByteStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceResolver.EndCreateObjectFromByteStream(SharpDX.MediaFoundation.AsyncResult,SharpDX.MediaFoundation.ObjectType@,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Completes an asynchronous request to create a media source from a byte stream.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong>Invoke</strong> method.</p> </dd></param>
|
|
<param name="objectTypeRef"><dd> <p>Receives a member of the <strong><see cref="T:SharpDX.MediaFoundation.ObjectType"/></strong> enumeration, specifying the type of object that was created.</p> </dd></param>
|
|
<param name="objectOut"><dd> <p>Receives a reference to the media source's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_ABORT</strong></dt> </dl> </td><td> <p>The application canceled the operation.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method from inside your application's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceResolver::EndCreateObjectFromByteStream']/*"/>
|
|
<msdn-id>ms697199</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceResolver::EndCreateObjectFromByteStream([In] IMFAsyncResult* pResult,[Out] MF_OBJECT_TYPE* pObjectType,[Out] IUnknown** ppObject)</unmanaged>
|
|
<unmanaged-short>IMFSourceResolver::EndCreateObjectFromByteStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SourceResolver.CancelObjectCreation(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Cancels an asynchronous request to create an object. </p>
|
|
</summary>
|
|
<param name="iUnknownCancelCookieRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface that was returned in the <em>ppIUnknownCancelCookie</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.SourceResolver.BeginCreateObjectFromByteStream(SharpDX.MediaFoundation.ByteStream,System.String,System.Int32,SharpDX.ComObject,SharpDX.ComObject@,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.SourceResolver.BeginCreateObjectFromURL(System.String,System.Int32,SharpDX.ComObject,SharpDX.ComObject@,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> You can use this method to cancel a previous call to <strong>BeginCreateObjectFromByteStream</strong> or <strong>BeginCreateObjectFromURL</strong>. Because these methods are asynchronous, however, they might be completed before the operation can be canceled. Therefore, your callback might still be invoked after you call this method. </p><p><strong>Note</strong>??This method cannot be called remotely.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSourceResolver::CancelObjectCreation']/*"/>
|
|
<msdn-id>ms698845</msdn-id>
|
|
<unmanaged>HRESULT IMFSourceResolver::CancelObjectCreation([In] IUnknown* pIUnknownCancelCookie)</unmanaged>
|
|
<unmanaged-short>IMFSourceResolver::CancelObjectCreation</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SSLCertificateManager">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Indicates whether the server SSL certificate must be verified by the caller, Media Foundation, or the <strong><see cref="T:SharpDX.MediaFoundation.SSLCertificateManager"/></strong> implementation class.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSSLCertificateManager']/*"/>
|
|
<msdn-id>dd374673</msdn-id>
|
|
<unmanaged>IMFSSLCertificateManager</unmanaged>
|
|
<unmanaged-short>IMFSSLCertificateManager</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SSLCertificateManager.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SSLCertificateManager"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SSLCertificateManager.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SSLCertificateManager">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SSLCertificateManager"/>. (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.MediaFoundation.SSLCertificateManager.GetClientCertificate(System.String,System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the client SSL certificate synchronously.</p>
|
|
</summary>
|
|
<param name="szURLRef"><dd> <p>Pointer to a string that contains the URL for which a client-side SSL certificate is required. Media Foundation can resolve the scheme and send the request to the server.</p> </dd></param>
|
|
<param name="bDataOut"><dd> <p>Pointer to the buffer that stores the certificate.This caller must free the buffer by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbDataRef"><dd> <p>Pointer to a <strong>DWORD</strong> variable that receives the number of bytes required to hold the certificate data in the buffer pointed by <em>*ppbData</em>.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSSLCertificateManager::GetClientCertificate']/*"/>
|
|
<msdn-id>dd374674</msdn-id>
|
|
<unmanaged>HRESULT IMFSSLCertificateManager::GetClientCertificate([In] const wchar_t* pszURL,[Out, Buffer] unsigned char** ppbData,[Out] unsigned int* pcbData)</unmanaged>
|
|
<unmanaged-short>IMFSSLCertificateManager::GetClientCertificate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SSLCertificateManager.BeginGetClientCertificate(System.String,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Starts an asynchronous call to get the client SSL certificate.</p>
|
|
</summary>
|
|
<param name="szURLRef"><dd> <p>A null-terminated string that contains the URL for which a client-side SSL certificate is required. Media Foundation can resolve the scheme and send the request to the server.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface.</p> </dd></param>
|
|
<param name="stateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>When the operation completes, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.SSLCertificateManager.EndGetClientCertificate(SharpDX.MediaFoundation.AsyncResult,System.Byte[],System.Int32@)"/></strong> to complete the asynchronous request. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSSLCertificateManager::BeginGetClientCertificate']/*"/>
|
|
<msdn-id>dd374671</msdn-id>
|
|
<unmanaged>HRESULT IMFSSLCertificateManager::BeginGetClientCertificate([In] const wchar_t* pszURL,[In] IMFAsyncCallback* pCallback,[In] IUnknown* pState)</unmanaged>
|
|
<unmanaged-short>IMFSSLCertificateManager::BeginGetClientCertificate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SSLCertificateManager.EndGetClientCertificate(SharpDX.MediaFoundation.AsyncResult,System.Byte[],System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Completes an asynchronous request to get the client SSL certificate. </p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. </p> </dd></param>
|
|
<param name="bDataOut"><dd> <p>Receives a reference to the buffer that stores the certificate.The caller must free the buffer by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbDataRef"><dd> <p>Receives the size of the <em>ppbData</em> buffer, in bytes.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call this method after the <strong><see cref="M:SharpDX.MediaFoundation.SSLCertificateManager.BeginGetClientCertificate(System.String,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSSLCertificateManager::EndGetClientCertificate']/*"/>
|
|
<msdn-id>dd374672</msdn-id>
|
|
<unmanaged>HRESULT IMFSSLCertificateManager::EndGetClientCertificate([In] IMFAsyncResult* pResult,[Out, Buffer] unsigned char** ppbData,[Out] unsigned int* pcbData)</unmanaged>
|
|
<unmanaged-short>IMFSSLCertificateManager::EndGetClientCertificate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SSLCertificateManager.GetCertificatePolicy(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Indicates whether the server SSL certificate must be verified by the caller, Media Foundation, or the <strong><see cref="T:SharpDX.MediaFoundation.SSLCertificateManager"/></strong> implementation class.</p>
|
|
</summary>
|
|
<param name="szURLRef"><dd> <p> Pointer to a string that contains the URL that is sent to the server.</p> </dd></param>
|
|
<param name="fOverrideAutomaticCheckRef"><dd> <p>Pointer to a <strong><see cref="T:System.Boolean"/></strong> value. Set to <strong>TRUE</strong> if <strong><see cref="M:SharpDX.MediaFoundation.SSLCertificateManager.OnServerCertificate(System.String,System.Byte[],System.Int32,System.Boolean)"/></strong> is used to verify the server certificate.Set to <strong><see cref="F:SharpDX.Result.False"/></strong> if Media Foundation verifies the server certificate by using the certificates in the Windows certificate store.</p> </dd></param>
|
|
<param name="fClientCertificateAvailableRef"><dd> <p>Pointer to a <strong><see cref="T:System.Boolean"/></strong> value. Set to <strong>TRUE</strong> if the SSL certificate for the client is available for immediate retrieval. Media Foundation calls <strong><see cref="M:SharpDX.MediaFoundation.SSLCertificateManager.GetClientCertificate(System.String,System.Byte[],System.Int32@)"/></strong> to obtain the client certificate synchronously. If the value is set to <strong><see cref="F:SharpDX.Result.False"/></strong>, Media Foundation obtains the client SSL certificate with an asynchronous call to <strong><see cref="M:SharpDX.MediaFoundation.SSLCertificateManager.BeginGetClientCertificate(System.String,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSSLCertificateManager::GetCertificatePolicy']/*"/>
|
|
<msdn-id>dd374673</msdn-id>
|
|
<unmanaged>HRESULT IMFSSLCertificateManager::GetCertificatePolicy([In] const wchar_t* pszURL,[In] BOOL* pfOverrideAutomaticCheck,[In] BOOL* pfClientCertificateAvailable)</unmanaged>
|
|
<unmanaged-short>IMFSSLCertificateManager::GetCertificatePolicy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SSLCertificateManager.OnServerCertificate(System.String,System.Byte[],System.Int32,System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Called by Media Foundation when the server SSL certificate has been received; indicates whether the server certificate is accepted.</p>
|
|
</summary>
|
|
<param name="szURLRef"><dd> <p>Pointer to a string that contains the URL used to send the request to the server, and for which a server-side SSL certificate has been received.</p> </dd></param>
|
|
<param name="bDataRef"><dd> <p>Pointer to a buffer that contains the server SSL certificate.</p> </dd></param>
|
|
<param name="cbData"><dd> <p>Pointer to a <strong>DWORD</strong> variable that indicates the size of <em>pbData</em> in bytes.</p> </dd></param>
|
|
<param name="fIsGoodRef"><dd> <p>Pointer to a <strong><see cref="T:System.Boolean"/></strong> variable that indicates whether the certificate is accepted.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSSLCertificateManager::OnServerCertificate']/*"/>
|
|
<msdn-id>dd374675</msdn-id>
|
|
<unmanaged>HRESULT IMFSSLCertificateManager::OnServerCertificate([In] const wchar_t* pszURL,[In, Buffer] unsigned char* pbData,[In] unsigned int cbData,[In] BOOL* pfIsGood)</unmanaged>
|
|
<unmanaged-short>IMFSSLCertificateManager::OnServerCertificate</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.StreamDescriptor">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets information about one stream in a media source. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>A presentation descriptor contains one or more stream descriptors. To get the stream descriptors from a presentation descriptor, call <strong><see cref="M:SharpDX.MediaFoundation.PresentationDescriptor.GetStreamDescriptorByIndex(System.Int32,System.Boolean@,SharpDX.MediaFoundation.StreamDescriptor@)"/></strong>. To create a new stream descriptor, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateStreamDescriptor(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType[],SharpDX.MediaFoundation.StreamDescriptor@)"/></strong>.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamDescriptor']/*"/>
|
|
<msdn-id>ms701622</msdn-id>
|
|
<unmanaged>IMFStreamDescriptor</unmanaged>
|
|
<unmanaged-short>IMFStreamDescriptor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamDescriptor.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.StreamDescriptor"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamDescriptor.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.StreamDescriptor">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.StreamDescriptor"/>. (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.MediaFoundation.StreamDescriptor.GetStreamIdentifier(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves an identifier for the stream.</p>
|
|
</summary>
|
|
<param name="dwStreamIdentifierRef"><dd> <p>Receives the stream identifier.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The stream identifier uniquely identifies a stream within a presentation. It does not change throughout the lifetime of the stream. For example, if the presentation changes while the source is running, the index number of the stream may change, but the stream identifier does not.</p><p>In general, stream identifiers do not have a specific meaning, other than to identify the stream. Some media sources may assign stream identifiers based on meaningful values, such as packet identifiers, but this depends on the implementation.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamDescriptor::GetStreamIdentifier']/*"/>
|
|
<msdn-id>ms703852</msdn-id>
|
|
<unmanaged>HRESULT IMFStreamDescriptor::GetStreamIdentifier([Out] unsigned int* pdwStreamIdentifier)</unmanaged>
|
|
<unmanaged-short>IMFStreamDescriptor::GetStreamIdentifier</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamDescriptor.GetMediaTypeHandler(SharpDX.MediaFoundation.MediaTypeHandler@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a media type handler for the stream. The media type handler can be used to enumerate supported media types for the stream, get the current media type, and set the media type.</p>
|
|
</summary>
|
|
<param name="mediaTypeHandlerOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaTypeHandler"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamDescriptor::GetMediaTypeHandler']/*"/>
|
|
<msdn-id>ms700210</msdn-id>
|
|
<unmanaged>HRESULT IMFStreamDescriptor::GetMediaTypeHandler([Out] IMFMediaTypeHandler** ppMediaTypeHandler)</unmanaged>
|
|
<unmanaged-short>IMFStreamDescriptor::GetMediaTypeHandler</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.StreamDescriptor.StreamIdentifier">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves an identifier for the stream.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The stream identifier uniquely identifies a stream within a presentation. It does not change throughout the lifetime of the stream. For example, if the presentation changes while the source is running, the index number of the stream may change, but the stream identifier does not.</p><p>In general, stream identifiers do not have a specific meaning, other than to identify the stream. Some media sources may assign stream identifiers based on meaningful values, such as packet identifiers, but this depends on the implementation.</p><p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamDescriptor::GetStreamIdentifier']/*"/>
|
|
<msdn-id>ms703852</msdn-id>
|
|
<unmanaged>GetStreamIdentifier</unmanaged>
|
|
<unmanaged-short>GetStreamIdentifier</unmanaged-short>
|
|
<unmanaged>HRESULT IMFStreamDescriptor::GetStreamIdentifier([Out] unsigned int* pdwStreamIdentifier)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.StreamDescriptor.MediaTypeHandler">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves a media type handler for the stream. The media type handler can be used to enumerate supported media types for the stream, get the current media type, and set the media type.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This interface is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamDescriptor::GetMediaTypeHandler']/*"/>
|
|
<msdn-id>ms700210</msdn-id>
|
|
<unmanaged>GetMediaTypeHandler</unmanaged>
|
|
<unmanaged-short>GetMediaTypeHandler</unmanaged-short>
|
|
<unmanaged>HRESULT IMFStreamDescriptor::GetMediaTypeHandler([Out] IMFMediaTypeHandler** ppMediaTypeHandler)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.StreamingSinkConfig">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Called by the streaming media client before the Media Session starts streaming to specify the byte offset or the time offset.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamingSinkConfig']/*"/>
|
|
<msdn-id>dd374677</msdn-id>
|
|
<unmanaged>IMFStreamingSinkConfig</unmanaged>
|
|
<unmanaged-short>IMFStreamingSinkConfig</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamingSinkConfig.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.StreamingSinkConfig"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamingSinkConfig.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.StreamingSinkConfig">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.StreamingSinkConfig"/>. (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.MediaFoundation.StreamingSinkConfig.StartStreaming(System.Boolean,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Called by the streaming media client before the Media Session starts streaming to specify the byte offset or the time offset.</p>
|
|
</summary>
|
|
<param name="fSeekOffsetIsByteOffset"><dd> <p> A Boolean value that specifies whether <em>qwSeekOffset</em> gives a byte offset of a time offset.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>TRUE</strong></dt> </dl> </td><td> <p>The <em>qwSeekOffset</em> parameter specifies a byte offset.</p> </td></tr> <tr><td><dl> <dt><strong><see cref="F:SharpDX.Result.False"/></strong></dt> </dl> </td><td> <p>The <em>qwSeekOffset</em> parameter specifies the time position in 100-nanosecond units.</p> </td></tr> </table> <p>?</p> </dd></param>
|
|
<param name="qwSeekOffset"><dd> <p>A byte offset or a time offset, depending on the value passed in <em>fSeekOffsetIsByteOffset</em>. Time offsets are specified in 100-nanosecond units.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamingSinkConfig::StartStreaming']/*"/>
|
|
<msdn-id>dd374677</msdn-id>
|
|
<unmanaged>HRESULT IMFStreamingSinkConfig::StartStreaming([In] BOOL fSeekOffsetIsByteOffset,[In] unsigned longlong qwSeekOffset)</unmanaged>
|
|
<unmanaged-short>IMFStreamingSinkConfig::StartStreaming</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.StreamSink">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Places a marker in the stream. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method causes the stream sink to send an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkMarker"/> event after the stream sink consumes all of the samples that were delivered up to this point (before the call to <strong>PlaceMarker</strong>).</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamSink']/*"/>
|
|
<msdn-id>ms703026</msdn-id>
|
|
<unmanaged>IMFStreamSink</unmanaged>
|
|
<unmanaged-short>IMFStreamSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamSink.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.StreamSink"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamSink.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.StreamSink">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.StreamSink"/>. (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.MediaFoundation.StreamSink.GetMediaSink(SharpDX.MediaFoundation.MediaSink@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the media sink that owns this stream sink.</p>
|
|
</summary>
|
|
<param name="mediaSinkOut"><dd> <p>Receives a reference to the media sink's <strong><see cref="T:SharpDX.MediaFoundation.MediaSink"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINK_REMOVED</strong></dt> </dl> </td><td> <p>This stream was removed from the media sink and is no longer valid.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamSink::GetMediaSink']/*"/>
|
|
<msdn-id>ms699003</msdn-id>
|
|
<unmanaged>HRESULT IMFStreamSink::GetMediaSink([Out] IMFMediaSink** ppMediaSink)</unmanaged>
|
|
<unmanaged-short>IMFStreamSink::GetMediaSink</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamSink.GetIdentifier(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the stream identifier for this stream sink.</p>
|
|
</summary>
|
|
<param name="dwIdentifierRef"><dd> <p>Receives the stream identifier. If this stream sink was added by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong>, the stream identifier is in the <em>dwStreamSinkIdentifier</em> parameter of that method. Otherwise, the media sink defines the identifier.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINK_REMOVED</strong></dt> </dl> </td><td> <p>This stream was removed from the media sink and is no longer valid.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamSink::GetIdentifier']/*"/>
|
|
<msdn-id>ms702129</msdn-id>
|
|
<unmanaged>HRESULT IMFStreamSink::GetIdentifier([Out] unsigned int* pdwIdentifier)</unmanaged>
|
|
<unmanaged-short>IMFStreamSink::GetIdentifier</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamSink.GetMediaTypeHandler(SharpDX.MediaFoundation.MediaTypeHandler@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the media type handler for the stream sink. You can use the media type handler to find which formats the stream supports, and to set the media type on the stream.</p>
|
|
</summary>
|
|
<param name="handlerOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaTypeHandler"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINK_REMOVED</strong></dt> </dl> </td><td> <p>This stream was removed from the media sink and is no longer valid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the stream sink currently does not support any media types, this method returns a media type handler that fails any calls to <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.GetCurrentMediaType(SharpDX.MediaFoundation.MediaType@)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.IsMediaTypeSupported(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamSink::GetMediaTypeHandler']/*"/>
|
|
<msdn-id>ms700107</msdn-id>
|
|
<unmanaged>HRESULT IMFStreamSink::GetMediaTypeHandler([Out] IMFMediaTypeHandler** ppHandler)</unmanaged>
|
|
<unmanaged-short>IMFStreamSink::GetMediaTypeHandler</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamSink.ProcessSample(SharpDX.MediaFoundation.Sample)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Delivers a sample to the stream. The media sink processes the sample.</p>
|
|
</summary>
|
|
<param name="sampleRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of a sample that contains valid data for the stream.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALID_STATE_TRANSITION</strong></dt> </dl> </td><td> <p>The media sink is in the wrong state to receive a sample. For example, preroll is complete but the presenation clock has not started yet.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALID_TIMESTAMP</strong></dt> </dl> </td><td> <p>The sample has an invalid time stamp. See Remarks.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The media sink is paused or stopped and cannot process the sample.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_CLOCK</strong></dt> </dl> </td><td> <p>The presentation clock was not set. Call <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.SetPresentationClock(SharpDX.MediaFoundation.PresentationClock)"/></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_SAMPLE_TIMESTAMP</strong></dt> </dl> </td><td> <p>The sample does not have a time stamp.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The stream sink has not been initialized.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINK_REMOVED</strong></dt> </dl> </td><td> <p>This stream was removed from the media sink and is no longer valid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method when the stream sink sends an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkRequestSample"/> event.</p><p>This method can return MF_E_INVALID_TIMESTAMP for various reasons, depending on the implementation of the media sink:</p><ul> <li> <p>Negative time stamps.</p> </li> <li> <p>Time stamps that jump backward (within the same stream).</p> </li> <li> <p>The time stamps for one stream have drifted too far from the time stamps on another stream within the same media sink (for example, an archive sink that multiplexes the streams).</p> </li> </ul><p>Not every media sink returns an error code in these situations.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamSink::ProcessSample']/*"/>
|
|
<msdn-id>ms696208</msdn-id>
|
|
<unmanaged>HRESULT IMFStreamSink::ProcessSample([In, Optional] IMFSample* pSample)</unmanaged>
|
|
<unmanaged-short>IMFStreamSink::ProcessSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamSink.PlaceMarker(SharpDX.MediaFoundation.StreamsinkMarkerType,SharpDX.Win32.Variant,SharpDX.Win32.Variant)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Places a marker in the stream. </p>
|
|
</summary>
|
|
<param name="eMarkerType"><dd> <p> Specifies the marker type, as a member of the <strong><see cref="T:SharpDX.MediaFoundation.StreamsinkMarkerType"/></strong> enumeration. </p> </dd></param>
|
|
<param name="varMarkerValueRef"><dd> <p> Optional reference to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that contains additional information related to the marker. The meaning of this value depends on the marker type. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="varContextValueRef"><dd> <p> Optional reference to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that is attached to the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkMarker"/> event. Call <strong><see cref="M:SharpDX.MediaFoundation.MediaEvent.GetValue(SharpDX.Win32.Variant@)"/></strong> to get this value from the event. The caller can use this information for any purpose. This parameter can be <strong><c>null</c></strong>. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><strong><see cref="F:SharpDX.Result.Ok"/></strong></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_SHUTDOWN</strong></strong></dt> </dl> </td><td> <p> The media sink's <strong>Shutdown</strong> method has been called. </p> </td></tr> <tr><td> <dl> <dt><strong><strong>MF_E_STREAMSINK_REMOVED</strong></strong></dt> </dl> </td><td> <p> This stream was removed from the media sink and is no longer valid. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method causes the stream sink to send an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkMarker"/> event after the stream sink consumes all of the samples that were delivered up to this point (before the call to <strong>PlaceMarker</strong>).</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamSink::PlaceMarker']/*"/>
|
|
<msdn-id>ms703026</msdn-id>
|
|
<unmanaged>HRESULT IMFStreamSink::PlaceMarker([In] MFSTREAMSINK_MARKER_TYPE eMarkerType,[In] const PROPVARIANT* pvarMarkerValue,[In] const PROPVARIANT* pvarContextValue)</unmanaged>
|
|
<unmanaged-short>IMFStreamSink::PlaceMarker</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.StreamSink.Flush">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Causes the stream sink to drop any samples that it has received and has not rendered yet.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_INITIALIZED</strong></dt> </dl> </td><td> <p>The stream sink has not been initialized yet. You might need to set a media type.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The media sink's <strong>Shutdown</strong> method has been called.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_STREAMSINK_REMOVED</strong></dt> </dl> </td><td> <p>This stream was removed from the media sink and is no longer valid.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If any samples are still queued from previous calls to the <strong><see cref="M:SharpDX.MediaFoundation.StreamSink.ProcessSample(SharpDX.MediaFoundation.Sample)"/></strong> method, the media sink immediately discards them, without processing them. This can cause a glitch in the rendered output. The running state of the sink (running, paused, or stopped) does not change.</p><p>Any pending marker events from the <strong><see cref="M:SharpDX.MediaFoundation.StreamSink.PlaceMarker(SharpDX.MediaFoundation.StreamsinkMarkerType,SharpDX.Win32.Variant,SharpDX.Win32.Variant)"/></strong> method are dispatched immediately, with the status code E_ABORT.</p><p>This method is synchronous. It does not return until the sink has discarded all pending samples.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamSink::Flush']/*"/>
|
|
<msdn-id>ms697054</msdn-id>
|
|
<unmanaged>HRESULT IMFStreamSink::Flush()</unmanaged>
|
|
<unmanaged-short>IMFStreamSink::Flush</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.StreamSink.MediaSink">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the media sink that owns this stream sink.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamSink::GetMediaSink']/*"/>
|
|
<msdn-id>ms699003</msdn-id>
|
|
<unmanaged>GetMediaSink</unmanaged>
|
|
<unmanaged-short>GetMediaSink</unmanaged-short>
|
|
<unmanaged>HRESULT IMFStreamSink::GetMediaSink([Out] IMFMediaSink** ppMediaSink)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.StreamSink.Identifier">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the stream identifier for this stream sink.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamSink::GetIdentifier']/*"/>
|
|
<msdn-id>ms702129</msdn-id>
|
|
<unmanaged>GetIdentifier</unmanaged>
|
|
<unmanaged-short>GetIdentifier</unmanaged-short>
|
|
<unmanaged>HRESULT IMFStreamSink::GetIdentifier([Out] unsigned int* pdwIdentifier)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.StreamSink.MediaTypeHandler">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the media type handler for the stream sink. You can use the media type handler to find which formats the stream supports, and to set the media type on the stream.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the stream sink currently does not support any media types, this method returns a media type handler that fails any calls to <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.GetCurrentMediaType(SharpDX.MediaFoundation.MediaType@)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.MediaTypeHandler.IsMediaTypeSupported(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaType@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFStreamSink::GetMediaTypeHandler']/*"/>
|
|
<msdn-id>ms700107</msdn-id>
|
|
<unmanaged>GetMediaTypeHandler</unmanaged>
|
|
<unmanaged-short>GetMediaTypeHandler</unmanaged-short>
|
|
<unmanaged>HRESULT IMFStreamSink::GetMediaTypeHandler([Out] IMFMediaTypeHandler** ppHandler)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SystemId">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Provides a method that retireves system id data.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSystemId']/*"/>
|
|
<msdn-id>hh448067</msdn-id>
|
|
<unmanaged>IMFSystemId</unmanaged>
|
|
<unmanaged-short>IMFSystemId</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SystemId.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.SystemId"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SystemId.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.SystemId">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.SystemId"/>. (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.MediaFoundation.SystemId.GetData(System.Int32@,System.Byte[])">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Retrieves system id data.</p>
|
|
</summary>
|
|
<param name="size"><dd> <p>The size in bytes of the returned data.</p> </dd></param>
|
|
<param name="data"><dd> <p>Receives the returned data. The caller must free this buffer by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFSystemId::GetData']/*"/>
|
|
<msdn-id>hh448068</msdn-id>
|
|
<unmanaged>HRESULT IMFSystemId::GetData([Out] unsigned int* size,[Out, Buffer] unsigned char** data)</unmanaged>
|
|
<unmanaged-short>IMFSystemId::GetData</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.SystemId.Setup(System.Int32,System.Int32,System.Byte[],System.Int32@,System.Byte[])">
|
|
<summary>
|
|
<p> </p>
|
|
</summary>
|
|
<param name="stage">No documentation.</param>
|
|
<param name="cbIn">No documentation.</param>
|
|
<param name="bInRef">No documentation.</param>
|
|
<param name="cbOutRef">No documentation.</param>
|
|
<param name="bOutOut">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='IMFSystemId::Setup']/*"/>
|
|
<msdn-id>ms696268</msdn-id>
|
|
<unmanaged>HRESULT IMFSystemId::Setup([In] unsigned int stage,[In] unsigned int cbIn,[In, Buffer] const unsigned char* pbIn,[Out] unsigned int* pcbOut,[Out, Buffer] unsigned char** ppbOut)</unmanaged>
|
|
<unmanaged-short>IMFSystemId::Setup</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TimecodeTranslate">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Converts between Society of Motion Picture and Television Engineers (SMPTE) time codes and 100-nanosecond time units.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If an object supports this interface, it must expose the interface as a service. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> with the service identifier <strong>MF_TIMECODE_SERVICE</strong>.</p><p>The Advanced Streaming Format (ASF) media source exposes this interface.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTimecodeTranslate']/*"/>
|
|
<msdn-id>dd374678</msdn-id>
|
|
<unmanaged>IMFTimecodeTranslate</unmanaged>
|
|
<unmanaged-short>IMFTimecodeTranslate</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TimecodeTranslate.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TimecodeTranslate"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TimecodeTranslate.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TimecodeTranslate">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TimecodeTranslate"/>. (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.MediaFoundation.TimecodeTranslate.BeginConvertTimecodeToHNS(SharpDX.Win32.Variant,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Starts an asynchronous call to convert Society of Motion Picture and Television Engineers (SMPTE) time code to 100-nanosecond units.</p>
|
|
</summary>
|
|
<param name="propVarTimecodeRef"><dd> <p>Time in SMPTE time code to convert. The <strong>vt</strong> member of the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> structure is set to <strong>VT_I8</strong>. The <strong>hVal.QuadPart</strong> member contains the time in binary coded decimal (BCD) form. See Remarks.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface.</p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>PPointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>pPropVarTimecode</em> is not <strong>VT_I8</strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BYTESTREAM_NOT_SEEKABLE</strong></dt> </dl> </td><td> <p>The byte stream is not seekable. The time code cannot be read from the end of the byte stream.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When the asynchronous method completes, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application must call <strong><see cref="M:SharpDX.MediaFoundation.TimecodeTranslate.EndConvertTimecodeToHNS(SharpDX.MediaFoundation.AsyncResult,System.Int64)"/></strong> to complete the asynchronous request.</p><p>The value of <em>pPropVarTimecode</em> is a 64-bit unsigned value typed as a <strong>LONGLONG</strong>. The upper <strong>DWORD</strong> contains the range. (A <em>range</em> is a continuous series of time codes.) The lower <strong>DWORD</strong> contains the time code in the form of a hexadecimal number <em>0xhhmmssff</em>, where each 2-byte sequence is read as a decimal value.</p><pre>void CreateTimeCode( DWORD dwFrames, DWORD dwSeconds, DWORD dwMinutes, DWORD dwHours, DWORD dwRange, <see cref="T:SharpDX.Win32.Variant"/> *pvar )
|
|
{ ULONGLONG ullTimecode = ((ULONGLONG)dwRange) << 32; ullTimecode += dwFrames % 10; ullTimecode += (( (ULONGLONG)dwFrames ) / 10) << 4; ullTimecode += (( (ULONGLONG)dwSeconds ) % 10) << 8; ullTimecode += (( (ULONGLONG)dwSeconds ) / 10) << 12; ullTimecode += (( (ULONGLONG)dwMinutes ) % 10) << 16; ullTimecode += (( (ULONGLONG)dwMinutes ) / 10) << 20; ullTimecode += (( (ULONGLONG)dwHours ) % 10) << 24; ullTimecode += (( (ULONGLONG)dwHours ) / 10) << 28; pvar->vt = VT_I8; pvar->hVal.QuadPart = (LONGLONG)ullTimecode;
|
|
}
|
|
</pre>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTimecodeTranslate::BeginConvertTimecodeToHNS']/*"/>
|
|
<msdn-id>dd374680</msdn-id>
|
|
<unmanaged>HRESULT IMFTimecodeTranslate::BeginConvertTimecodeToHNS([In] const PROPVARIANT* pPropVarTimecode,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFTimecodeTranslate::BeginConvertTimecodeToHNS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TimecodeTranslate.EndConvertTimecodeToHNS(SharpDX.MediaFoundation.AsyncResult,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Completes an asynchronous request to convert time in Society of Motion Picture and Television Engineers (SMPTE) time code to 100-nanosecond units.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. </p> </dd></param>
|
|
<param name="hnsTimeRef"><dd> <p>Receives the converted time.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call this method after the <strong><see cref="M:SharpDX.MediaFoundation.TimecodeTranslate.BeginConvertTimecodeToHNS(SharpDX.Win32.Variant,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTimecodeTranslate::EndConvertTimecodeToHNS']/*"/>
|
|
<msdn-id>dd374682</msdn-id>
|
|
<unmanaged>HRESULT IMFTimecodeTranslate::EndConvertTimecodeToHNS([In] IMFAsyncResult* pResult,[In] longlong* phnsTime)</unmanaged>
|
|
<unmanaged-short>IMFTimecodeTranslate::EndConvertTimecodeToHNS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TimecodeTranslate.BeginConvertHNSToTimecode(System.Int64,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Starts an asynchronous call to convert time in 100-nanosecond units to Society of Motion Picture and Television Engineers (SMPTE) time code.</p>
|
|
</summary>
|
|
<param name="hnsTime"><dd> <p>The time to convert, in 100-nanosecond units.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface. </p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The object's <strong>Shutdown</strong> method was called.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BYTESTREAM_NOT_SEEKABLE</strong></dt> </dl> </td><td> <p>The byte stream is not seekable. The time code cannot be read from the end of the byte stream.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When the asynchronous method completes, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application must call <strong><see cref="M:SharpDX.MediaFoundation.TimecodeTranslate.EndConvertHNSToTimecode(SharpDX.MediaFoundation.AsyncResult,SharpDX.Win32.Variant)"/></strong> to complete the asynchronous request.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTimecodeTranslate::BeginConvertHNSToTimecode']/*"/>
|
|
<msdn-id>dd374679</msdn-id>
|
|
<unmanaged>HRESULT IMFTimecodeTranslate::BeginConvertHNSToTimecode([In] longlong hnsTime,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState)</unmanaged>
|
|
<unmanaged-short>IMFTimecodeTranslate::BeginConvertHNSToTimecode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TimecodeTranslate.EndConvertHNSToTimecode(SharpDX.MediaFoundation.AsyncResult,SharpDX.Win32.Variant)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Completes an asynchronous request to convert time in 100-nanosecond units to Society of Motion Picture and Television Engineers (SMPTE) time code.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p> </dd></param>
|
|
<param name="propVarTimecodeRef"><dd> <p>A reference to a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that receives the converted time. The <strong>vt</strong> member of the <strong><see cref="T:SharpDX.Win32.Variant"/></strong> structure is set to VT_I8. The <strong>hVal.QuadPart</strong> member contains the converted time in binary coded decimal (BCD) form. See Remarks.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call this method after the <strong><see cref="M:SharpDX.MediaFoundation.TimecodeTranslate.BeginConvertHNSToTimecode(System.Int64,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously.</p><p>The value of <em>pPropVarTimecode</em> is a 64-bit unsigned value typed as a <strong>LONGLONG</strong>. The upper <strong>DWORD</strong> contains the range. (A <em>range</em> is a continuous series of time codes.) The lower <strong>DWORD</strong> contains the time code in the form of a hexadecimal number <em>0xhhmmssff</em>, where each 2-byte sequence is read as a decimal value.</p><pre><see cref="T:SharpDX.Result"/> ParseTimeCode( const <see cref="T:SharpDX.Win32.Variant"/>& var, DWORD *pdwRange, DWORD *pdwFrames, DWORD *pdwSeconds, DWORD *pdwMinutes, DWORD *pdwHours )
|
|
{ if (var.vt != VT_I8) { return E_INVALIDARG; } ULONGLONG ullTimeCode = (ULONGLONG)var.hVal.QuadPart; DWORD dwTimecode = (DWORD)(ullTimeCode & 0xFFFFFFFF); *pdwRange = (DWORD)(ullTimeCode >> 32); *pdwFrames = dwTimecode & 0x0000000F; *pdwFrames += (( dwTimecode & 0x000000F0) >> 4 ) * 10; *pdwSeconds = ( dwTimecode & 0x00000F00) >> 8; *pdwSeconds += (( dwTimecode & 0x0000F000) >> 12 ) * 10; *pdwMinutes = ( dwTimecode & 0x000F0000) >> 16; *pdwMinutes += (( dwTimecode & 0x00F00000) >> 20 ) * 10; *pdwHours = ( dwTimecode & 0x0F000000) >> 24; *pdwHours += (( dwTimecode & 0xF0000000) >> 28 ) * 10; return <see cref="F:SharpDX.Result.Ok"/>;
|
|
}
|
|
</pre>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTimecodeTranslate::EndConvertHNSToTimecode']/*"/>
|
|
<msdn-id>dd374681</msdn-id>
|
|
<unmanaged>HRESULT IMFTimecodeTranslate::EndConvertHNSToTimecode([In] IMFAsyncResult* pResult,[In] PROPVARIANT* pPropVarTimecode)</unmanaged>
|
|
<unmanaged-short>IMFTimecodeTranslate::EndConvertHNSToTimecode</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Timer">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets a timer that invokes a callback at the specified time.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the clock is stopped, the method returns MF_S_CLOCK_STOPPED. The callback will not be invoked until the clock is started.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTimer']/*"/>
|
|
<msdn-id>ms696252</msdn-id>
|
|
<unmanaged>IMFTimer</unmanaged>
|
|
<unmanaged-short>IMFTimer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Timer.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Timer"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Timer.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Timer">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Timer"/>. (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.MediaFoundation.Timer.SetTimer(System.Int32,System.Int64,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets a timer that invokes a callback at the specified time.</p>
|
|
</summary>
|
|
<param name="dwFlags"><dd> <p>Bitwise OR of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.TimerFlags"/></strong> enumeration.</p> </dd></param>
|
|
<param name="llClockTime"><dd> <p>The time at which the timer should fire, in units of the clock's frequency. The time is either absolute or relative to the current time, depending on the value of <em>dwFlags</em>.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface. The callback's <strong>Invoke</strong> method is called at the time specified in the <em>llClockTime</em> parameter.</p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<param name="unkKeyOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a cancellation object. The caller must release the interface. To cancel the timer, pass this reference to the <strong><see cref="M:SharpDX.MediaFoundation.Timer.CancelTimer(SharpDX.ComObject)"/></strong> method. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The clock was shut down.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_S_CLOCK_STOPPED</strong></dt> </dl> </td><td> <p>The method succeeded, but the clock is stopped.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the clock is stopped, the method returns MF_S_CLOCK_STOPPED. The callback will not be invoked until the clock is started.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTimer::SetTimer']/*"/>
|
|
<msdn-id>ms696252</msdn-id>
|
|
<unmanaged>HRESULT IMFTimer::SetTimer([In] unsigned int dwFlags,[In] longlong llClockTime,[In] IMFAsyncCallback* pCallback,[In] IUnknown* punkState,[In] IUnknown** ppunkKey)</unmanaged>
|
|
<unmanaged-short>IMFTimer::SetTimer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Timer.CancelTimer(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Cancels a timer that was set using the <strong><see cref="M:SharpDX.MediaFoundation.Timer.SetTimer(System.Int32,System.Int64,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject,SharpDX.ComObject@)"/></strong> method.</p>
|
|
</summary>
|
|
<param name="unkKeyRef">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Because the timer is dispatched asynchronously, the application's timer callback might get invoked even if this method succeeds.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTimer::CancelTimer']/*"/>
|
|
<msdn-id>ms696276</msdn-id>
|
|
<unmanaged>HRESULT IMFTimer::CancelTimer([In] IUnknown* punkKey)</unmanaged>
|
|
<unmanaged-short>IMFTimer::CancelTimer</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TopoLoader">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Converts a partial topology into a full topology. The topology loader exposes this interface.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To create the topology loader, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTopoLoader(SharpDX.MediaFoundation.TopoLoader@)"/></strong> function.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopoLoader']/*"/>
|
|
<msdn-id>ms697375</msdn-id>
|
|
<unmanaged>IMFTopoLoader</unmanaged>
|
|
<unmanaged-short>IMFTopoLoader</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopoLoader.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TopoLoader"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopoLoader.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TopoLoader">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TopoLoader"/>. (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.MediaFoundation.TopoLoader.Load(SharpDX.MediaFoundation.Topology,SharpDX.MediaFoundation.Topology@,SharpDX.MediaFoundation.Topology)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Creates a fully loaded topology from the input partial topology. </p>
|
|
</summary>
|
|
<param name="inputTopoRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface of the partial topology to be resolved.</p> </dd></param>
|
|
<param name="outputTopoOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface of the completed topology. The caller must release the interface.</p> </dd></param>
|
|
<param name="currentTopoRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface of the previous full topology. The topology loader can re-use objects from this topology in the new topology. This parameter can be <strong><c>null</c></strong>. See Remarks. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TOPO_SINK_ACTIVATES_UNSUPPORTED</strong></dt> </dl> </td><td> <p>One or more output nodes contain <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> references. The caller must bind the output nodes to media sinks. See Binding Output Nodes to Media Sinks.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> This method creates any intermediate transforms that are needed to complete the topology. It also sets the input and output media types on all of the objects in the topology. If the method succeeds, the full topology is returned in the <em>ppOutputTopo</em> parameter. </p><p> You can use the <em>pCurrentTopo</em> parameter to provide a full topology that was previously loaded. If this topology contains objects that are needed in the new topology, the topology loader can re-use them without creating them again. This caching can potentially make the process faster. The objects from <em>pCurrentTopo</em> will not be reconfigured, so you can specify a topology that is actively streaming data. For example, while a topology is still running, you can pre-load the next topology. </p><p> Before calling this method, you must ensure that the output nodes in the partial topology have valid <strong><see cref="T:SharpDX.MediaFoundation.StreamSink"/></strong> references, not <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> references. The Media Session automatically performs this action inside the <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.SetTopology(System.Int32,SharpDX.MediaFoundation.Topology)"/></strong> method. However, if you call <strong>Load</strong> before calling <strong>SetTopology</strong>, you must bind the output nodes manually. For more information, see Binding Output Nodes to Media Sinks. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopoLoader::Load']/*"/>
|
|
<msdn-id>ms693561</msdn-id>
|
|
<unmanaged>HRESULT IMFTopoLoader::Load([In] IMFTopology* pInputTopo,[Out] IMFTopology** ppOutputTopo,[In] IMFTopology* pCurrentTopo)</unmanaged>
|
|
<unmanaged-short>IMFTopoLoader::Load</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Topology">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the output nodes in the topology. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology']/*"/>
|
|
<msdn-id>ms694029</msdn-id>
|
|
<unmanaged>IMFTopology</unmanaged>
|
|
<unmanaged-short>IMFTopology</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Topology"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Topology">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Topology"/>. (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.MediaFoundation.Topology.GetTopologyID(System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the identifier of the topology.</p>
|
|
</summary>
|
|
<param name="iDRef"><dd> <p> Receives the identifier, as a <strong>TOPOID</strong> value. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::GetTopologyID']/*"/>
|
|
<msdn-id>ms705620</msdn-id>
|
|
<unmanaged>HRESULT IMFTopology::GetTopologyID([Out] unsigned longlong* pID)</unmanaged>
|
|
<unmanaged-short>IMFTopology::GetTopologyID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.AddNode(SharpDX.MediaFoundation.TopologyNode)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Adds a node to the topology.</p>
|
|
</summary>
|
|
<param name="nodeRef"><dd> <p>Pointer to the node's <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>pNode</em> is invalid, possibly because the node already exists in the topology.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::AddNode']/*"/>
|
|
<msdn-id>ms697365</msdn-id>
|
|
<unmanaged>HRESULT IMFTopology::AddNode([In] IMFTopologyNode* pNode)</unmanaged>
|
|
<unmanaged-short>IMFTopology::AddNode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.RemoveNode(SharpDX.MediaFoundation.TopologyNode)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Removes a node from the topology.</p>
|
|
</summary>
|
|
<param name="nodeRef"><dd> <p>Pointer to the node's <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The specified node is not a member of this topology.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method does not destroy the node, so the <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> reference is still valid after the method returns.</p><p>The method breaks any connections between the specified node and other nodes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::RemoveNode']/*"/>
|
|
<msdn-id>ms694226</msdn-id>
|
|
<unmanaged>HRESULT IMFTopology::RemoveNode([In] IMFTopologyNode* pNode)</unmanaged>
|
|
<unmanaged-short>IMFTopology::RemoveNode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.GetNodeCount(System.Int16@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the number of nodes in the topology. </p>
|
|
</summary>
|
|
<param name="wNodesRef"><dd> <p> Receives the number of nodes. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::GetNodeCount']/*"/>
|
|
<msdn-id>ms700175</msdn-id>
|
|
<unmanaged>HRESULT IMFTopology::GetNodeCount([Out] unsigned short* pwNodes)</unmanaged>
|
|
<unmanaged-short>IMFTopology::GetNodeCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.GetNode(System.Int16,SharpDX.MediaFoundation.TopologyNode@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets a node in the topology, specified by index. </p>
|
|
</summary>
|
|
<param name="wIndex"><dd> <p> The zero-based index of the node. To get the number of nodes in the topology, call <strong><see cref="M:SharpDX.MediaFoundation.Topology.GetNodeCount(System.Int16@)"/></strong>. </p> </dd></param>
|
|
<param name="nodeOut"><dd> <p> Receives a reference to the node's <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface. The caller must release the reference. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> The index is less than zero. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDINDEX</strong></dt> </dl> </td><td> <p> No node can be found at the index <em>wIndex</em>. </p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::GetNode']/*"/>
|
|
<msdn-id>ms701569</msdn-id>
|
|
<unmanaged>HRESULT IMFTopology::GetNode([In] unsigned short wIndex,[Out] IMFTopologyNode** ppNode)</unmanaged>
|
|
<unmanaged-short>IMFTopology::GetNode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.Clear">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Removes all nodes from the topology.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You do not need to clear a topology before disposing of it. The <strong>Clear</strong> method is called automatically when the topology is destroyed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::Clear']/*"/>
|
|
<msdn-id>ms700800</msdn-id>
|
|
<unmanaged>HRESULT IMFTopology::Clear()</unmanaged>
|
|
<unmanaged-short>IMFTopology::Clear</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.CloneFrom(SharpDX.MediaFoundation.Topology)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Converts this topology into a copy of another topology. </p>
|
|
</summary>
|
|
<param name="topologyRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Topology"/></strong> interface of the topology to clone. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This method does the following:</p><ul> <li> Removes all of the nodes from this topology. </li> <li> Clones the nodes from <em>pTopology</em> and adds them to this topology. The cloned nodes have the same node identifiers as the nodes from <em>pTopology</em>. </li> <li> Connects the cloned nodes to match the connections in <em>pTopology</em>. </li> <li> Copies the attributes from <em>pTopology</em> to this topology. </li> <li> Copies the topology identifier from <em>pTopology</em> to this topology.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::CloneFrom']/*"/>
|
|
<msdn-id>ms702242</msdn-id>
|
|
<unmanaged>HRESULT IMFTopology::CloneFrom([In, Optional] IMFTopology* pTopology)</unmanaged>
|
|
<unmanaged-short>IMFTopology::CloneFrom</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.GetNodeByID(System.Int64,SharpDX.MediaFoundation.TopologyNode@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets a node in the topology, specified by node identifier.</p>
|
|
</summary>
|
|
<param name="qwTopoNodeID"><dd> <p> The identifier of the node to retrieve. To get a node's identifier, call <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.GetTopoNodeID(System.Int64@)"/></strong>. </p> </dd></param>
|
|
<param name="nodeOut"><dd> <p> Receives a reference to the node's <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_FOUND</strong></dt> </dl> </td><td> <p> The topology does not contain a node with this identifier. </p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::GetNodeByID']/*"/>
|
|
<msdn-id>ms696224</msdn-id>
|
|
<unmanaged>HRESULT IMFTopology::GetNodeByID([In] unsigned longlong qwTopoNodeID,[Out] IMFTopologyNode** ppNode)</unmanaged>
|
|
<unmanaged-short>IMFTopology::GetNodeByID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.GetSourceNodeCollection(SharpDX.MediaFoundation.Collection@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the source nodes in the topology. </p>
|
|
</summary>
|
|
<param name="collectionOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Collection"/></strong> interface. The caller must release the reference. The collection contains <strong><see cref="T:SharpDX.ComObject"/></strong> references to all of the source nodes in the topology. Each reference can be queried for the <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface. The collection might be empty.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::GetSourceNodeCollection']/*"/>
|
|
<msdn-id>ms701611</msdn-id>
|
|
<unmanaged>HRESULT IMFTopology::GetSourceNodeCollection([Out] IMFCollection** ppCollection)</unmanaged>
|
|
<unmanaged-short>IMFTopology::GetSourceNodeCollection</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Topology.GetOutputNodeCollection(SharpDX.MediaFoundation.Collection@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the output nodes in the topology. </p>
|
|
</summary>
|
|
<param name="collectionOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Collection"/></strong> interface. The caller must release the reference. The collection contains <strong><see cref="T:SharpDX.ComObject"/></strong> references to all of the output nodes in the topology. Each reference can be queried for the <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface. The collection might be empty. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::GetOutputNodeCollection']/*"/>
|
|
<msdn-id>ms694029</msdn-id>
|
|
<unmanaged>HRESULT IMFTopology::GetOutputNodeCollection([Out] IMFCollection** ppCollection)</unmanaged>
|
|
<unmanaged-short>IMFTopology::GetOutputNodeCollection</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Topology.TopologyID">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the identifier of the topology.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::GetTopologyID']/*"/>
|
|
<msdn-id>ms705620</msdn-id>
|
|
<unmanaged>GetTopologyID</unmanaged>
|
|
<unmanaged-short>GetTopologyID</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTopology::GetTopologyID([Out] unsigned longlong* pID)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Topology.NodeCount">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the number of nodes in the topology. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::GetNodeCount']/*"/>
|
|
<msdn-id>ms700175</msdn-id>
|
|
<unmanaged>GetNodeCount</unmanaged>
|
|
<unmanaged-short>GetNodeCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTopology::GetNodeCount([Out] unsigned short* pwNodes)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Topology.SourceNodeCollection">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the source nodes in the topology. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::GetSourceNodeCollection']/*"/>
|
|
<msdn-id>ms701611</msdn-id>
|
|
<unmanaged>GetSourceNodeCollection</unmanaged>
|
|
<unmanaged-short>GetSourceNodeCollection</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTopology::GetSourceNodeCollection([Out] IMFCollection** ppCollection)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Topology.OutputNodeCollection">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the output nodes in the topology. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopology::GetOutputNodeCollection']/*"/>
|
|
<msdn-id>ms694029</msdn-id>
|
|
<unmanaged>GetOutputNodeCollection</unmanaged>
|
|
<unmanaged-short>GetOutputNodeCollection</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTopology::GetOutputNodeCollection([Out] IMFCollection** ppCollection)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TopologyNode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Connects an output stream from this node to the input stream of another node.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Node connections represent data flow from one node to the next. The streams are logical, and are specified by index.</p><p>If the node is already connected at the specified output, the method breaks the existing connection. If <em>dwOutputIndex</em> or <em>dwInputIndexOnDownstreamNode</em> specify streams that do not exist yet, the method adds as many streams as needed.</p><p>This method checks for certain invalid conditions:</p><ul> <li> <p>An output node cannot have any output connections. If you call this method on an output node, the method returns E_FAIL.</p> </li> <li> <p>A node cannot be connected to itself. If <em>pDownstreamNode</em> specifies the same node as the method call, the method returns E_INVALIDARG.</p> </li> </ul><p>However, if the method succeeds, it does not guarantee that the node connection is valid. It is possible to create a partial topology that the topology loader cannot resolve. If so, the <strong><see cref="M:SharpDX.MediaFoundation.TopoLoader.Load(SharpDX.MediaFoundation.Topology,SharpDX.MediaFoundation.Topology@,SharpDX.MediaFoundation.Topology)"/></strong> method will fail.</p><p>To break an existing node connection, call <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.DisconnectOutput(System.Int32)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode']/*"/>
|
|
<msdn-id>ms695284</msdn-id>
|
|
<unmanaged>IMFTopologyNode</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TopologyNode"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TopologyNode">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TopologyNode"/>. (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.MediaFoundation.TopologyNode.SetObject(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the object associated with this node.</p>
|
|
</summary>
|
|
<param name="objectRef"><dd> <p>A reference to the object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. Use the value <strong><c>null</c></strong> to clear an object that was previous set.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>All node types support this method, but the object reference is not used by every node type.</p><table> <tr><th>Node type</th><th>Object reference</th></tr> <tr><td>Source node.</td><td>Not used.</td></tr> <tr><td>Transform node.</td><td> <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> or <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface.</td></tr> <tr><td>Output node</td><td> <strong><see cref="T:SharpDX.MediaFoundation.StreamSink"/></strong> or <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface.</td></tr> <tr><td>Tee node.</td><td>Not used.</td></tr> </table><p>?</p><p>If the object supports <strong><see cref="!:SharpDX.ComPersistBase"/></strong>, <strong>IPersistStorage</strong>, or <strong>IPersistPropertyBag</strong>, the method gets the object's CLSID and sets the <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.TransformObjectid"/></strong> attribute on the node.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::SetObject']/*"/>
|
|
<msdn-id>ms702992</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::SetObject([In, Optional] IUnknown* pObject)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::SetObject</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.GetObjectW(SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the object associated with this node. </p>
|
|
</summary>
|
|
<param name="objectOut"><dd> <p> Receives a reference to the object's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_FAIL</strong></dt> </dl> </td><td> <p> There is no object associated with this node. </p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetObjectW']/*"/>
|
|
<msdn-id>ms693569</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetObjectW([Out] IUnknown** ppObject)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::GetObjectW</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.GetNodeType(SharpDX.MediaFoundation.TopologyType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the node type.</p>
|
|
</summary>
|
|
<param name="typeRef"><dd> <p>Receives the node type, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.TopologyType"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetNodeType']/*"/>
|
|
<msdn-id>ms697514</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetNodeType([Out] MF_TOPOLOGY_TYPE* pType)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::GetNodeType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.GetTopoNodeID(System.Int64@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Retrieves the identifier of the node.</p>
|
|
</summary>
|
|
<param name="iDRef"><dd> <p>Receives the identifier.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> When a node is first created, it is assigned an identifier. Node identifiers are unique within a topology, but can be reused across several topologies. The topology loader uses the identifier to look up nodes in the previous topology, so that it can reuse objects from the previous topology. </p><p> To find a node in a topology by its identifier, call <strong><see cref="M:SharpDX.MediaFoundation.Topology.GetNodeByID(System.Int64,SharpDX.MediaFoundation.TopologyNode@)"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetTopoNodeID']/*"/>
|
|
<msdn-id>ms701602</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetTopoNodeID([Out] unsigned longlong* pID)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::GetTopoNodeID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.SetTopoNodeID(System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Sets the identifier for the node.</p>
|
|
</summary>
|
|
<param name="ullTopoID"><dd> <p> The identifier for the node. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> The <strong>TOPOID</strong> has already been set for this object. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> When a node is first created, it is assigned an identifier. Typically there is no reason for an application to override the identifier. Within a topology, each node identifier should be unique. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::SetTopoNodeID']/*"/>
|
|
<msdn-id>bb970438</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::SetTopoNodeID([In] unsigned longlong ullTopoID)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::SetTopoNodeID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.GetInputCount(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of input streams that currently exist on this node.</p>
|
|
</summary>
|
|
<param name="cInputsRef"><dd> <p>Receives the number of input streams.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The input streams may or may not be connected to output streams on other nodes. To get the node that is connected to a specified input stream, call <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.GetInput(System.Int32,SharpDX.MediaFoundation.TopologyNode@,System.Int32@)"/></strong>.</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.ConnectOutput(System.Int32,SharpDX.MediaFoundation.TopologyNode,System.Int32)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.SetInputPrefType(System.Int32,SharpDX.MediaFoundation.MediaType)"/></strong> methods add new input streams as needed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetInputCount']/*"/>
|
|
<msdn-id>ms700165</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetInputCount([Out] unsigned int* pcInputs)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::GetInputCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.GetOutputCount(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of output streams that currently exist on this node.</p>
|
|
</summary>
|
|
<param name="cOutputsRef"><dd> <p>Receives the number of output streams.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The output streams may or may not be connected to input streams on other nodes. To get the node that is connected to a specific output stream on this node, call <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.GetOutput(System.Int32,SharpDX.MediaFoundation.TopologyNode@,System.Int32@)"/></strong>.</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.ConnectOutput(System.Int32,SharpDX.MediaFoundation.TopologyNode,System.Int32)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.SetOutputPrefType(System.Int32,SharpDX.MediaFoundation.MediaType)"/></strong> methods add new input streams as needed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetOutputCount']/*"/>
|
|
<msdn-id>ms704019</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetOutputCount([Out] unsigned int* pcOutputs)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::GetOutputCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.ConnectOutput(System.Int32,SharpDX.MediaFoundation.TopologyNode,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Connects an output stream from this node to the input stream of another node.</p>
|
|
</summary>
|
|
<param name="dwOutputIndex"><dd> <p>Zero-based index of the output stream on this node.</p> </dd></param>
|
|
<param name="downstreamNodeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface of the node to connect to.</p> </dd></param>
|
|
<param name="dwInputIndexOnDownstreamNode"><dd> <p>Zero-based index of the input stream on the other node.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_FAIL</strong></dt> </dl> </td><td> <p>The method failed.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid parameter.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Node connections represent data flow from one node to the next. The streams are logical, and are specified by index.</p><p>If the node is already connected at the specified output, the method breaks the existing connection. If <em>dwOutputIndex</em> or <em>dwInputIndexOnDownstreamNode</em> specify streams that do not exist yet, the method adds as many streams as needed.</p><p>This method checks for certain invalid conditions:</p><ul> <li> <p>An output node cannot have any output connections. If you call this method on an output node, the method returns E_FAIL.</p> </li> <li> <p>A node cannot be connected to itself. If <em>pDownstreamNode</em> specifies the same node as the method call, the method returns E_INVALIDARG.</p> </li> </ul><p>However, if the method succeeds, it does not guarantee that the node connection is valid. It is possible to create a partial topology that the topology loader cannot resolve. If so, the <strong><see cref="M:SharpDX.MediaFoundation.TopoLoader.Load(SharpDX.MediaFoundation.Topology,SharpDX.MediaFoundation.Topology@,SharpDX.MediaFoundation.Topology)"/></strong> method will fail.</p><p>To break an existing node connection, call <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.DisconnectOutput(System.Int32)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::ConnectOutput']/*"/>
|
|
<msdn-id>ms695284</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::ConnectOutput([In] unsigned int dwOutputIndex,[In] IMFTopologyNode* pDownstreamNode,[In] unsigned int dwInputIndexOnDownstreamNode)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::ConnectOutput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.DisconnectOutput(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Disconnects an output stream on this node.</p>
|
|
</summary>
|
|
<param name="dwOutputIndex"><dd> <p>Zero-based index of the output stream to disconnect.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The <em>dwOutputIndex</em> parameter is out of range.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_FOUND</strong></dt> </dl> </td><td> <p>The specified output stream is not connected to another node.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If the specified output stream is connected to another node, this method breaks the connection.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::DisconnectOutput']/*"/>
|
|
<msdn-id>ms698991</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::DisconnectOutput([In] unsigned int dwOutputIndex)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::DisconnectOutput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.GetInput(System.Int32,SharpDX.MediaFoundation.TopologyNode@,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the node that is connected to a specified input stream on this node.</p>
|
|
</summary>
|
|
<param name="dwInputIndex"><dd> <p>Zero-based index of an input stream on this node.</p> </dd></param>
|
|
<param name="upstreamNodeOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface of the node that is connected to the specified input stream. The caller must release the interface.</p> </dd></param>
|
|
<param name="dwOutputIndexOnUpstreamNodeRef"><dd> <p>Receives the index of the output stream that is connected to this node's input stream.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The index is out of range.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOT_FOUND</strong></dt> </dl> </td><td> <p>The specified input stream is not connected to another node.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetInput']/*"/>
|
|
<msdn-id>ms697020</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetInput([In] unsigned int dwInputIndex,[Out] IMFTopologyNode** ppUpstreamNode,[Out] unsigned int* pdwOutputIndexOnUpstreamNode)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::GetInput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.GetOutput(System.Int32,SharpDX.MediaFoundation.TopologyNode@,System.Int32@)">
|
|
<summary>
|
|
<p>Retrieves the node that is connected to a specified output stream on this node.</p> <see cref="T:SharpDX.Result"/> GetOutput( DWORD dwOutputIndex, <see cref="T:SharpDX.MediaFoundation.TopologyNode"/>** ppDownstreamNode, DWORD* pdwInputIndexOnDownstreamNode
|
|
);
|
|
<p></p>Parameters <p> dwOutputIndex </p> <p>[in] Zero-based index of an output stream on this node.</p> <p> ppDownstreamNode </p> <p>[out] Receives a reference to the <see cref="T:SharpDX.MediaFoundation.TopologyNode"/> Interface of the node that is connected to the specified output stream.</p> <p> pdwInputIndexOnDownstreamNode </p> <p>[out] Receives the index of the input stream that is connected to this node's output stream.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded. </p> </td> </tr><tr> <td> <p>E_INVALIDARG</p> </td> <td> <p>The index is out of range.</p> </td> </tr><tr> <td> <p>MF_E_NOT_FOUND</p> </td> <td> <p>The specified input stream is not connected to another node.</p> </td> </tr></table> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFTopologyNode InterfaceConceptsTopologies
|
|
</summary>
|
|
<param name="dwOutputIndex">No documentation.</param>
|
|
<param name="downstreamNodeOut">No documentation.</param>
|
|
<param name="dwInputIndexOnDownstreamNodeRef">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='IMFTopologyNode::GetOutput']/*"/>
|
|
<msdn-id>ms704826</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetOutput([In] unsigned int dwOutputIndex,[Out] IMFTopologyNode** ppDownstreamNode,[Out] unsigned int* pdwInputIndexOnDownstreamNode)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::GetOutput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.SetOutputPrefType(System.Int32,SharpDX.MediaFoundation.MediaType)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the preferred media type for an output stream on this node.</p>
|
|
</summary>
|
|
<param name="dwOutputIndex"><dd> <p>Zero-based index of the output stream.</p> </dd></param>
|
|
<param name="typeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>This node is an output node.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The preferred type is a hint for the topology loader.</p><p>Do not call this method after loading a topology or setting a topology on the Media Session. Changing the preferred type on a running topology can cause connection errors.</p><p>If no output stream exists at the specified index, the method creates new streams up to and including the specified index number.</p><p>Output nodes cannot have outputs. If this method is called on an output node, it returns E_NOTIMPL</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::SetOutputPrefType']/*"/>
|
|
<msdn-id>ms701546</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::SetOutputPrefType([In] unsigned int dwOutputIndex,[In] IMFMediaType* pType)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::SetOutputPrefType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.GetOutputPrefType(System.Int32,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the preferred media type for an output stream on this node.</p>
|
|
</summary>
|
|
<param name="dwOutputIndex"><dd> <p>Zero-based index of the output stream.</p> </dd></param>
|
|
<param name="typeOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_FAIL</strong></dt> </dl> </td><td> <p>This node does not have a preferred output type.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid stream index.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>This node is an output node.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Output nodes cannot have outputs. If this method is called on an output node, it returns E_NOTIMPL.</p><p>The preferred output type provides a hint to the topology loader. In a fully resolved topology, there is no guarantee that every topology node will have a preferred output type. To get the actual media type for a node, you must get a reference to the node's underlying object. (For more information, see <strong><see cref="T:SharpDX.MediaFoundation.TopologyType"/></strong> enumeration.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetOutputPrefType']/*"/>
|
|
<msdn-id>ms701571</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetOutputPrefType([In] unsigned int dwOutputIndex,[Out] IMFMediaType** ppType)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::GetOutputPrefType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.SetInputPrefType(System.Int32,SharpDX.MediaFoundation.MediaType)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the preferred media type for an input stream on this node.</p>
|
|
</summary>
|
|
<param name="dwInputIndex"><dd> <p>Zero-based index of the input stream.</p> </dd></param>
|
|
<param name="typeRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>This node is a source node.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The preferred type is a hint for the topology loader.</p><p>Do not call this method after loading a topology or setting a topology on the Media Session. Changing the preferred type on a running topology can cause connection errors.</p><p>If no input stream exists at the specified index, the method creates new streams up to and including the specified index number.</p><p>Source nodes cannot have inputs. If this method is called on a source node, it returns E_NOTIMPL.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::SetInputPrefType']/*"/>
|
|
<msdn-id>ms696223</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::SetInputPrefType([In] unsigned int dwInputIndex,[In] IMFMediaType* pType)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::SetInputPrefType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.GetInputPrefType(System.Int32,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the preferred media type for an input stream on this node.</p>
|
|
</summary>
|
|
<param name="dwInputIndex"><dd> <p>Zero-based index of the input stream.</p> </dd></param>
|
|
<param name="typeOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of the media type. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_FAIL</strong></dt> </dl> </td><td> <p>This node does not have a preferred input type.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Invalid stream index.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p>This node is a source node.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Source nodes cannot have inputs. If this method is called on a source node, it returns E_NOTIMPL.</p><p>The preferred input type provides a hint to the topology loader. In a fully resolved topology, there is no guarantee that every topology node will have a preferred input type. To get the actual media type for a node, you must get a reference to the node's underlying object. (For more information, see <strong><see cref="T:SharpDX.MediaFoundation.TopologyType"/></strong> enumeration.)</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetInputPrefType']/*"/>
|
|
<msdn-id>ms696221</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetInputPrefType([In] unsigned int dwInputIndex,[Out] IMFMediaType** ppType)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::GetInputPrefType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNode.CloneFrom(SharpDX.MediaFoundation.TopologyNode)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Copies the data from another topology node into this node.</p>
|
|
</summary>
|
|
<param name="nodeRef"><dd> <p> A reference to the <strong><see cref="T:SharpDX.MediaFoundation.TopologyNode"/></strong> interface of the node to copy. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p> The node types do not match. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> The two nodes must have the same node type. To get the node type, call <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.GetNodeType(SharpDX.MediaFoundation.TopologyType@)"/></strong>. </p><p> This method copies the object reference, preferred types, and attributes from <em>pNode</em> to this node. It also copies the <strong>TOPOID</strong> that uniquely identifies each node in a topology. It does not duplicate any of the connections from <em>pNode</em> to other nodes. </p><p> The purpose of this method is to copy nodes from one topology to another. Do not use duplicate nodes within the same topology. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::CloneFrom']/*"/>
|
|
<msdn-id>ms700790</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNode::CloneFrom([In, Optional] IMFTopologyNode* pNode)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNode::CloneFrom</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TopologyNode.Object">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the object associated with this node.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>All node types support this method, but the object reference is not used by every node type.</p><table> <tr><th>Node type</th><th>Object reference</th></tr> <tr><td>Source node.</td><td>Not used.</td></tr> <tr><td>Transform node.</td><td> <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> or <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface.</td></tr> <tr><td>Output node</td><td> <strong><see cref="T:SharpDX.MediaFoundation.StreamSink"/></strong> or <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface.</td></tr> <tr><td>Tee node.</td><td>Not used.</td></tr> </table><p>?</p><p>If the object supports <strong><see cref="!:SharpDX.ComPersistBase"/></strong>, <strong>IPersistStorage</strong>, or <strong>IPersistPropertyBag</strong>, the method gets the object's CLSID and sets the <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.TransformObjectid"/></strong> attribute on the node.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::SetObject']/*"/>
|
|
<msdn-id>ms702992</msdn-id>
|
|
<unmanaged>SetObject</unmanaged>
|
|
<unmanaged-short>SetObject</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTopologyNode::SetObject([In, Optional] IUnknown* pObject)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TopologyNode.ObjectW">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the object associated with this node. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetObjectW']/*"/>
|
|
<msdn-id>ms693569</msdn-id>
|
|
<unmanaged>GetObjectW</unmanaged>
|
|
<unmanaged-short>GetObjectW</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetObjectW([Out] IUnknown** ppObject)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TopologyNode.NodeType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the node type.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetNodeType']/*"/>
|
|
<msdn-id>ms697514</msdn-id>
|
|
<unmanaged>GetNodeType</unmanaged>
|
|
<unmanaged-short>GetNodeType</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetNodeType([Out] MF_TOPOLOGY_TYPE* pType)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TopologyNode.TopoNodeID">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Retrieves the identifier of the node.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> When a node is first created, it is assigned an identifier. Node identifiers are unique within a topology, but can be reused across several topologies. The topology loader uses the identifier to look up nodes in the previous topology, so that it can reuse objects from the previous topology. </p><p> To find a node in a topology by its identifier, call <strong><see cref="M:SharpDX.MediaFoundation.Topology.GetNodeByID(System.Int64,SharpDX.MediaFoundation.TopologyNode@)"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetTopoNodeID']/*"/>
|
|
<msdn-id>ms701602</msdn-id>
|
|
<unmanaged>GetTopoNodeID</unmanaged>
|
|
<unmanaged-short>GetTopoNodeID</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetTopoNodeID([Out] unsigned longlong* pID)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TopologyNode.InputCount">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of input streams that currently exist on this node.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The input streams may or may not be connected to output streams on other nodes. To get the node that is connected to a specified input stream, call <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.GetInput(System.Int32,SharpDX.MediaFoundation.TopologyNode@,System.Int32@)"/></strong>.</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.ConnectOutput(System.Int32,SharpDX.MediaFoundation.TopologyNode,System.Int32)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.SetInputPrefType(System.Int32,SharpDX.MediaFoundation.MediaType)"/></strong> methods add new input streams as needed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetInputCount']/*"/>
|
|
<msdn-id>ms700165</msdn-id>
|
|
<unmanaged>GetInputCount</unmanaged>
|
|
<unmanaged-short>GetInputCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetInputCount([Out] unsigned int* pcInputs)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TopologyNode.OutputCount">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the number of output streams that currently exist on this node.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The output streams may or may not be connected to input streams on other nodes. To get the node that is connected to a specific output stream on this node, call <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.GetOutput(System.Int32,SharpDX.MediaFoundation.TopologyNode@,System.Int32@)"/></strong>.</p><p>The <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.ConnectOutput(System.Int32,SharpDX.MediaFoundation.TopologyNode,System.Int32)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.TopologyNode.SetOutputPrefType(System.Int32,SharpDX.MediaFoundation.MediaType)"/></strong> methods add new input streams as needed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNode::GetOutputCount']/*"/>
|
|
<msdn-id>ms704019</msdn-id>
|
|
<unmanaged>GetOutputCount</unmanaged>
|
|
<unmanaged-short>GetOutputCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTopologyNode::GetOutputCount([Out] unsigned int* pcOutputs)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TopologyNodeAttributeEditor">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Updates the attributes of one or more nodes in the current topology.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Currently the only attribute that can be updated is the <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Mediastop"/></strong> attribute. The method ignores any other attributes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNodeAttributeEditor']/*"/>
|
|
<msdn-id>aa371868</msdn-id>
|
|
<unmanaged>IMFTopologyNodeAttributeEditor</unmanaged>
|
|
<unmanaged-short>IMFTopologyNodeAttributeEditor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNodeAttributeEditor.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TopologyNodeAttributeEditor"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyNodeAttributeEditor.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TopologyNodeAttributeEditor">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TopologyNodeAttributeEditor"/>. (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.MediaFoundation.TopologyNodeAttributeEditor.UpdateNodeAttributes(System.Int64,System.Int32,SharpDX.MediaFoundation.ToponodeAttributeUpdate[])">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Updates the attributes of one or more nodes in the current topology.</p>
|
|
</summary>
|
|
<param name="topoId"><dd> <p>Reserved.</p> </dd></param>
|
|
<param name="cUpdates"><dd> <p>The number of elements in the <em>pUpdates</em> array.</p> </dd></param>
|
|
<param name="updatesRef"><dd> <p>Pointer to an array of <strong><see cref="T:SharpDX.MediaFoundation.ToponodeAttributeUpdate"/></strong> structures. Each element of the array updates one attribute on a node.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Currently the only attribute that can be updated is the <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.Mediastop"/></strong> attribute. The method ignores any other attributes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyNodeAttributeEditor::UpdateNodeAttributes']/*"/>
|
|
<msdn-id>aa371868</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyNodeAttributeEditor::UpdateNodeAttributes([In] unsigned longlong TopoId,[In] unsigned int cUpdates,[In, Buffer] MFTOPONODE_ATTRIBUTE_UPDATE* pUpdates)</unmanaged>
|
|
<unmanaged-short>IMFTopologyNodeAttributeEditor::UpdateNodeAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TopologyServiceLookup">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Enables a custom video mixer or video presenter to get interface references from the Enhanced Video Renderer (EVR). The mixer can also use this interface to get interface references from the presenter, and the presenter can use it to get interface references from the mixer.</p><p>To use this interface, implement the <strong><see cref="T:SharpDX.MediaFoundation.TopologyServiceLookupClient"/></strong> interface on your custom mixer or presenter. The EVR calls <strong><see cref="M:SharpDX.MediaFoundation.TopologyServiceLookupClient.InitServicePointers(SharpDX.MediaFoundation.TopologyServiceLookup)"/></strong> with a reference to the EVR's <strong><see cref="T:SharpDX.MediaFoundation.TopologyServiceLookup"/></strong> interface.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyServiceLookup']/*"/>
|
|
<msdn-id>ms702001</msdn-id>
|
|
<unmanaged>IMFTopologyServiceLookup</unmanaged>
|
|
<unmanaged-short>IMFTopologyServiceLookup</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyServiceLookup.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TopologyServiceLookup"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyServiceLookup.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TopologyServiceLookup">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TopologyServiceLookup"/>. (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.MediaFoundation.TopologyServiceLookup.LookupService(SharpDX.MediaFoundation.ServiceLookupType,System.Int32,System.Guid,System.Guid,System.IntPtr,System.Int32@)">
|
|
<summary>
|
|
<p>Retrieves an interface from the enhanced video renderer (EVR), or from the video mixer or video presenter.</p> <see cref="T:SharpDX.Result"/> LookupService( <see cref="T:SharpDX.MediaFoundation.ServiceLookupType"/> Type, DWORD dwIndex, REFGUID guidService, REFIID riid, LPVOID* ppvObjects, DWORD* pnObjects
|
|
);
|
|
<p></p>Parameters <p> Type </p> <p>[in] Specifies the scope of the search. Currently this parameter is ignored. Use the value <see cref="F:SharpDX.MediaFoundation.ServiceLookupType.Global"/>.</p> <p> dwIndex </p> <p>[in] Reserved, must be zero.</p> <p> guidService </p> <p>[in] Service <see cref="T:System.Guid"/> of the requested interface.</p> <p> riid </p> <p>[in] Interface identifier of the requested interface.</p> <p> ppvObjects </p> <p>[out] Array of interface references. If the method succeeds, each member of the array is initialized to the requested interface. The caller must release the interface references when the EVR calls <see cref="M:SharpDX.MediaFoundation.TopologyServiceLookupClient.ReleaseServicePointers"/>.</p> <p> pnObjects </p> <p>[in, out] On input, a reference to a value that specifies the size of the ppvObjects array. The value must be at least 1. On output, receives the number of valid references copied into the ppvObjects array. In the current implementation, there is no particular reason to specify an array size larger than one element.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>E_INVALIDARG</p> </td> <td> <p>Invalid argument. </p> </td> </tr><tr> <td> <p>E_NOINTERFACE</p> </td> <td> <p>The requested interface is not available.</p> </td> </tr><tr> <td> <p>MF_E_NOTACCEPTING</p> </td> <td> <p>The method was not called from inside the InitServicePointers method. See Remarks.</p> </td> </tr><tr> <td> <p>MF_E_UNSUPPORTED_SERVICE</p> </td> <td> <p>The object does not support the specified service <see cref="T:System.Guid"/>.</p> </td> </tr></table> <p>This method can be called only from inside the <see cref="M:SharpDX.MediaFoundation.TopologyServiceLookupClient.InitServicePointers(SharpDX.MediaFoundation.TopologyServiceLookup)"/> method. At any other time, the method returns MF_E_NOTACCEPTING.</p> <p>The presenter can use this method to query the EVR and the mixer. The mixer can use it to query the EVR and the presenter. Which objects are queried depends on the caller and the service <see cref="T:System.Guid"/>, as shown in the following table. </p> <table><tr> <th> Caller </th> <th> Service <see cref="T:System.Guid"/> </th> <th> Objects queried </th> </tr><tr> <td> <p>Presenter</p> </td> <td> <p>MR_VIDEO_RENDER_SERVICE</p> </td> <td> <p>EVR</p> </td> </tr><tr> <td> <p>Presenter</p> </td> <td> <p>MR_VIDEO_MIXER_SERVICE</p> </td> <td> <p>Mixer</p> </td> </tr><tr> <td> <p>Mixer</p> </td> <td> <p>MR_VIDEO_RENDER_SERVICE</p> </td> <td> <p>Presenter and EVR</p> </td> </tr></table> <p>The following interfaces are available from the EVR:</p> <ul><li> <p> IMediaEventSink Interface</p> </li><li> <p> <see cref="T:SharpDX.MediaFoundation.Clock"/> Interface </p> </li><li> <p> <see cref="T:SharpDX.MediaFoundation.Timer"/> Interface </p> </li><li> <p> <see cref="T:SharpDX.MediaFoundation.PresentationClock"/> Interface </p> </li></ul> <p>The IMediaEventSink interface is documented in the DirectShow SDK documentation.</p> <p>The following interfaces are available from the mixer:</p> <ul><li> <p> <see cref="T:SharpDX.MediaFoundation.Transform"/> Interface </p> </li><li> <p> <see cref="T:SharpDX.MediaFoundation.VideoDeviceID"/> Interface </p> </li></ul> <p> Client: Requires Windows Vista.</p> <p> Header: Include evr.h.</p> <p> Library: Use strmiids.lib.</p> ReferenceIMFTopologyServiceLookup InterfaceConceptsHow to Write an EVR Presenter
|
|
</summary>
|
|
<param name="type">No documentation.</param>
|
|
<param name="dwIndex">No documentation.</param>
|
|
<param name="guidService">No documentation.</param>
|
|
<param name="riid">No documentation.</param>
|
|
<param name="vObjectsOut">No documentation.</param>
|
|
<param name="nObjectsRef">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='IMFTopologyServiceLookup::LookupService']/*"/>
|
|
<msdn-id>ms702184</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyServiceLookup::LookupService([In] MF_SERVICE_LOOKUP_TYPE Type,[In] unsigned int dwIndex,[In] const GUID& guidService,[In] const GUID& riid,[Out, Buffer] void** ppvObjects,[InOut] unsigned int* pnObjects)</unmanaged>
|
|
<unmanaged-short>IMFTopologyServiceLookup::LookupService</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TopologyServiceLookupClient">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Initializes a video mixer or presenter. This interface is implemented by mixers and presenters, and enables them to query the enhanced video renderer (EVR) for interface references.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>When the EVR loads the video mixer and the video presenter, the EVR queries the object for this interface and calls <strong>InitServicePointers</strong>. Inside the <strong>InitServicePointers</strong> method, the object can query the EVR for interface references.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyServiceLookupClient']/*"/>
|
|
<msdn-id>ms703063</msdn-id>
|
|
<unmanaged>IMFTopologyServiceLookupClient</unmanaged>
|
|
<unmanaged-short>IMFTopologyServiceLookupClient</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyServiceLookupClient.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TopologyServiceLookupClient"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyServiceLookupClient.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TopologyServiceLookupClient">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TopologyServiceLookupClient"/>. (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.MediaFoundation.TopologyServiceLookupClient.InitServicePointers(SharpDX.MediaFoundation.TopologyServiceLookup)">
|
|
<summary>
|
|
<p>Signals the mixer or presenter to query the enhanced video renderer (EVR) for interface references.</p> <see cref="T:SharpDX.Result"/> InitServicePointers( <see cref="T:SharpDX.MediaFoundation.TopologyServiceLookup"/>* pLookup
|
|
);
|
|
<p></p>Parameters <p> pLookup </p> <p>Pointer to the <see cref="T:SharpDX.MediaFoundation.TopologyServiceLookup"/> Interface. To query the EVR, call <see cref="M:SharpDX.MediaFoundation.TopologyServiceLookup.LookupService(SharpDX.MediaFoundation.ServiceLookupType,System.Int32,System.Guid,System.Guid,System.IntPtr,System.Int32@)"/>.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr></table> <p>The <see cref="T:SharpDX.MediaFoundation.TopologyServiceLookup"/> reference is guaranteed to be valid only during the call to InitServicePointers. The mixer or presenter should not store a reference to this interface after the method returns.</p> <p>When the EVR calls <see cref="M:SharpDX.MediaFoundation.TopologyServiceLookupClient.ReleaseServicePointers"/>, the mixer or presenter should release any references it obtained from the EVR.</p> <p> Client: Requires Windows Vista.</p> <p> Header: Include evr.h.</p> <p> Library: Use strmiids.lib.</p> ReferenceIMFTopologyServiceLookupClient Interface
|
|
</summary>
|
|
<param name="lookupRef">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='IMFTopologyServiceLookupClient::InitServicePointers']/*"/>
|
|
<msdn-id>ms704023</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyServiceLookupClient::InitServicePointers([In] IMFTopologyServiceLookup* pLookup)</unmanaged>
|
|
<unmanaged-short>IMFTopologyServiceLookupClient::InitServicePointers</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TopologyServiceLookupClient.ReleaseServicePointers">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Signals the object to release the interface references obtained from the enhanced video renderer (EVR).</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>After this method is called, any interface references obtained during the previous call to <strong><see cref="M:SharpDX.MediaFoundation.TopologyServiceLookupClient.InitServicePointers(SharpDX.MediaFoundation.TopologyServiceLookup)"/></strong> are no longer valid. The object must release them.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTopologyServiceLookupClient::ReleaseServicePointers']/*"/>
|
|
<msdn-id>ms693584</msdn-id>
|
|
<unmanaged>HRESULT IMFTopologyServiceLookupClient::ReleaseServicePointers()</unmanaged>
|
|
<unmanaged-short>IMFTopologyServiceLookupClient::ReleaseServicePointers</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TrackedSample">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the owner for the sample.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>When this method is called, the sample holds an additional reference count on itself. When every other object releases its reference counts on the sample, the sample invokes the <em>pSampleAllocator</em> callback method. To get a reference to the sample, call <strong><see cref="M:SharpDX.MediaFoundation.AsyncResult.GetObjectW(SharpDX.ComObject@)"/></strong> on the asynchronous result object given to the callback's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p><p>After the callback is invoked, the sample clears the callback. To reinstate the callback, you must call <strong>SetAllocator</strong> again.</p><p>It is safe to pass in the sample's <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface reference as the state object (<em>pUnkState</em>) for the callback. If <em>pUnkState</em> points to the sample, the <strong>SetAllocator</strong> method accounts for the additional reference count on <em>pUnkState</em>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTrackedSample']/*"/>
|
|
<msdn-id>ms704797</msdn-id>
|
|
<unmanaged>IMFTrackedSample</unmanaged>
|
|
<unmanaged-short>IMFTrackedSample</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrackedSample.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TrackedSample"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrackedSample.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TrackedSample">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TrackedSample"/>. (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.MediaFoundation.TrackedSample.SetAllocator(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Sets the owner for the sample.</p>
|
|
</summary>
|
|
<param name="sampleAllocatorRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface.</p> </dd></param>
|
|
<param name="unkStateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOTACCEPTING</strong></dt> </dl> </td><td> <p>The owner was already set. This method cannot be called twice on the sample.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>When this method is called, the sample holds an additional reference count on itself. When every other object releases its reference counts on the sample, the sample invokes the <em>pSampleAllocator</em> callback method. To get a reference to the sample, call <strong><see cref="M:SharpDX.MediaFoundation.AsyncResult.GetObjectW(SharpDX.ComObject@)"/></strong> on the asynchronous result object given to the callback's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p><p>After the callback is invoked, the sample clears the callback. To reinstate the callback, you must call <strong>SetAllocator</strong> again.</p><p>It is safe to pass in the sample's <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface reference as the state object (<em>pUnkState</em>) for the callback. If <em>pUnkState</em> points to the sample, the <strong>SetAllocator</strong> method accounts for the additional reference count on <em>pUnkState</em>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTrackedSample::SetAllocator']/*"/>
|
|
<msdn-id>ms704797</msdn-id>
|
|
<unmanaged>HRESULT IMFTrackedSample::SetAllocator([In] IMFAsyncCallback* pSampleAllocator,[In] IUnknown* pUnkState)</unmanaged>
|
|
<unmanaged-short>IMFTrackedSample::SetAllocator</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TranscodeProfile">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Implemented by the transcode profile object.</p><p>The transcode profile stores configuration settings that the topology builder uses to generate the transcode topology for the output file. These configuration settings are specified by the caller and include audio and video stream properties, encoder settings, and container settings that are specified by the caller.</p><p>To create the transcode profile object, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeProfile(SharpDX.MediaFoundation.TranscodeProfile@)"/></strong>. The configured transcode profile is passed to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeTopology(SharpDX.MediaFoundation.MediaSource,System.String,SharpDX.MediaFoundation.TranscodeProfile,SharpDX.MediaFoundation.Topology@)"/></strong>, which creates the transcode topology with the appropriate settings. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeProfile']/*"/>
|
|
<msdn-id>dd369139</msdn-id>
|
|
<unmanaged>IMFTranscodeProfile</unmanaged>
|
|
<unmanaged-short>IMFTranscodeProfile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeProfile.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TranscodeProfile"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeProfile.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TranscodeProfile">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TranscodeProfile"/>. (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.MediaFoundation.TranscodeProfile.SetAudioAttributes(SharpDX.MediaFoundation.MediaAttributes)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets audio stream configuration settings in the transcode profile.</p><p>To get a list of compatible audio media types supported by the Media Foundation transform (MFT) encoder , call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TranscodeGetAudioOutputAvailableTypes(System.Guid,System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.Collection@)"/></strong>. You can get the attributes that are set on the required media type and set them on the transcode profile. To set the audio attributes properly, create a new attribute store and copy the attribute store from the required media media type by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaAttributes.CopyAllItems(SharpDX.MediaFoundation.MediaAttributes)"/></strong>. This makes sure that the caller does not hold the references to the media type retrieved from the encoder. For example code, see <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeProfile(SharpDX.MediaFoundation.TranscodeProfile@)"/></strong>.</p>
|
|
</summary>
|
|
<param name="attrsRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeProfile::SetAudioAttributes']/*"/>
|
|
<msdn-id>dd369143</msdn-id>
|
|
<unmanaged>HRESULT IMFTranscodeProfile::SetAudioAttributes([In, Optional] IMFAttributes* pAttrs)</unmanaged>
|
|
<unmanaged-short>IMFTranscodeProfile::SetAudioAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeProfile.GetAudioAttributes(SharpDX.MediaFoundation.MediaAttributes@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the audio stream settings that are currently set in the transcode profile. </p>
|
|
</summary>
|
|
<param name="attrsOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of the attribute store containing the current audio stream settings. Caller must release the interface reference.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>If there are no audio attributes set in the transcode profile, the call to <strong>GetAudioAttributes</strong> succeeds and <em>ppAttrs</em> receives <strong><c>null</c></strong>.</p><p>To get a specific attribute value, the caller must call the appropriate <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> method depending on the data type of the attribute, and specify the attribute name. The following topics describe the audio attributes:</p><ul> <li> Audio Media Types </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeEncodingprofile"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeQualityvsspeed"/> </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeProfile::GetAudioAttributes']/*"/>
|
|
<msdn-id>dd369140</msdn-id>
|
|
<unmanaged>HRESULT IMFTranscodeProfile::GetAudioAttributes([Out, Optional] IMFAttributes** ppAttrs)</unmanaged>
|
|
<unmanaged-short>IMFTranscodeProfile::GetAudioAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeProfile.SetVideoAttributes(SharpDX.MediaFoundation.MediaAttributes)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets video stream configuration settings in the transcode profile.</p><p> For example code, see <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeProfile(SharpDX.MediaFoundation.TranscodeProfile@)"/></strong>.</p>
|
|
</summary>
|
|
<param name="attrsRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeProfile::SetVideoAttributes']/*"/>
|
|
<msdn-id>dd369145</msdn-id>
|
|
<unmanaged>HRESULT IMFTranscodeProfile::SetVideoAttributes([In, Optional] IMFAttributes* pAttrs)</unmanaged>
|
|
<unmanaged-short>IMFTranscodeProfile::SetVideoAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeProfile.GetVideoAttributes(SharpDX.MediaFoundation.MediaAttributes@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the video stream settings that are currently set in the transcode profile.</p>
|
|
</summary>
|
|
<param name="attrsOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of the attribute store containing the current video stream settings. Caller must release the interface reference.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>If there are no container attributes set in the transcode profile, the <strong>GetVideoAttributes</strong> method succeeds and <em>ppAttrs</em> receives <strong><c>null</c></strong>.</p><p>To get a specific attribute value, the caller must call the appropriate <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> method depending on the data type of the attribute, and specify the attribute name. The following list shows the video attributes:</p><ul> <li> Video Media Types </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeEncodingprofile"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeQualityvsspeed"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeDonotInsertEncoder"/> </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeProfile::GetVideoAttributes']/*"/>
|
|
<msdn-id>dd369142</msdn-id>
|
|
<unmanaged>HRESULT IMFTranscodeProfile::GetVideoAttributes([Out, Optional] IMFAttributes** ppAttrs)</unmanaged>
|
|
<unmanaged-short>IMFTranscodeProfile::GetVideoAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeProfile.SetContainerAttributes(SharpDX.MediaFoundation.MediaAttributes)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets container configuration settings in the transcode profile.</p><p> For example code, see <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeProfile(SharpDX.MediaFoundation.TranscodeProfile@)"/></strong>.</p>
|
|
</summary>
|
|
<param name="attrsRef">No documentation.</param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeProfile::SetContainerAttributes']/*"/>
|
|
<msdn-id>dd369144</msdn-id>
|
|
<unmanaged>HRESULT IMFTranscodeProfile::SetContainerAttributes([In, Optional] IMFAttributes* pAttrs)</unmanaged>
|
|
<unmanaged-short>IMFTranscodeProfile::SetContainerAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeProfile.GetContainerAttributes(SharpDX.MediaFoundation.MediaAttributes@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the container settings that are currently set in the transcode profile.</p>
|
|
</summary>
|
|
<param name="attrsOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface of the attribute store containing the current container type for the output file. Caller must release the interface reference.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>If there are no container attributes set in the transcode profile, the call to <strong>GetContainerAttributes</strong> succeeds and <em>ppAttrs</em> receives <strong><c>null</c></strong>.</p><p> To get a specific attribute value, the caller must call the appropriate <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> method depending on the data type of the attribute. The following list shows the container attributes:</p><ul> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeSkipMetadataTransfer"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeTopologymode"/> </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeProfile::GetContainerAttributes']/*"/>
|
|
<msdn-id>dd369141</msdn-id>
|
|
<unmanaged>HRESULT IMFTranscodeProfile::GetContainerAttributes([Out, Optional] IMFAttributes** ppAttrs)</unmanaged>
|
|
<unmanaged-short>IMFTranscodeProfile::GetContainerAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TranscodeProfile.AudioAttributes">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the audio stream settings that are currently set in the transcode profile. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If there are no audio attributes set in the transcode profile, the call to <strong>GetAudioAttributes</strong> succeeds and <em>ppAttrs</em> receives <strong><c>null</c></strong>.</p><p>To get a specific attribute value, the caller must call the appropriate <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> method depending on the data type of the attribute, and specify the attribute name. The following topics describe the audio attributes:</p><ul> <li> Audio Media Types </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeEncodingprofile"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeQualityvsspeed"/> </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeProfile::GetAudioAttributes']/*"/>
|
|
<msdn-id>dd369140</msdn-id>
|
|
<unmanaged>GetAudioAttributes</unmanaged>
|
|
<unmanaged-short>GetAudioAttributes</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTranscodeProfile::GetAudioAttributes([Out, Optional] IMFAttributes** ppAttrs)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TranscodeProfile.VideoAttributes">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the video stream settings that are currently set in the transcode profile.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If there are no container attributes set in the transcode profile, the <strong>GetVideoAttributes</strong> method succeeds and <em>ppAttrs</em> receives <strong><c>null</c></strong>.</p><p>To get a specific attribute value, the caller must call the appropriate <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> method depending on the data type of the attribute, and specify the attribute name. The following list shows the video attributes:</p><ul> <li> Video Media Types </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeEncodingprofile"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeQualityvsspeed"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeDonotInsertEncoder"/> </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeProfile::GetVideoAttributes']/*"/>
|
|
<msdn-id>dd369142</msdn-id>
|
|
<unmanaged>GetVideoAttributes</unmanaged>
|
|
<unmanaged-short>GetVideoAttributes</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTranscodeProfile::GetVideoAttributes([Out, Optional] IMFAttributes** ppAttrs)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TranscodeProfile.ContainerAttributes">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the container settings that are currently set in the transcode profile.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If there are no container attributes set in the transcode profile, the call to <strong>GetContainerAttributes</strong> succeeds and <em>ppAttrs</em> receives <strong><c>null</c></strong>.</p><p> To get a specific attribute value, the caller must call the appropriate <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> method depending on the data type of the attribute. The following list shows the container attributes:</p><ul> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeSkipMetadataTransfer"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeTopologymode"/> </li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeProfile::GetContainerAttributes']/*"/>
|
|
<msdn-id>dd369141</msdn-id>
|
|
<unmanaged>GetContainerAttributes</unmanaged>
|
|
<unmanaged-short>GetContainerAttributes</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTranscodeProfile::GetContainerAttributes([Out, Optional] IMFAttributes** ppAttrs)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TranscodeSinkInfoProvider">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Implemented by the transcode sink activation object.</p><p>The transcode sink activation object can be used to create any of the following file sinks:</p><ul> <li>3GP file sink</li> <li>MP3 file sink</li> <li>MP4 file sink</li> </ul>
|
|
</summary>
|
|
<remarks>
|
|
<p>To use this interface, perform the following steps:</p><ol> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeSinkActivate(SharpDX.MediaFoundation.Activate@)"/></strong> to create the transcode sink activation object.</li> <li>Query the activation object for the <strong><see cref="T:SharpDX.MediaFoundation.TranscodeSinkInfoProvider"/></strong> interface.</li> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeProfile(SharpDX.MediaFoundation.TranscodeProfile@)"/></strong> to create a transcode profile.</li> <li>Set the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute on the transcode profile. The attribute must have one of the following values:<ul> <li><strong>MFTranscodeContainerType_3GP</strong></li> <li><strong>MFTranscodeContainerType_MP3</strong></li> <li><strong>MFTranscodeContainerType_MPEG4</strong></li> </ul> </li> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.TranscodeProfile.SetVideoAttributes(SharpDX.MediaFoundation.MediaAttributes)"/></strong> and <strong><see cref="M:SharpDX.MediaFoundation.TranscodeProfile.SetAudioAttributes(SharpDX.MediaFoundation.MediaAttributes)"/></strong> to specify the video and audio formats.</li> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetProfile(SharpDX.MediaFoundation.TranscodeProfile)"/></strong> to set the transcode profile.</li> <li>Call one of the following methods (but not both) to specify the output file:<ul> <li> <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetOutputByteStream(SharpDX.MediaFoundation.Activate)"/></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetOutputFile(System.String)"/></strong> </li> </ul> </li> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> on the activation object to create the media sink.</li> </ol>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeSinkInfoProvider']/*"/>
|
|
<msdn-id>dd369146</msdn-id>
|
|
<unmanaged>IMFTranscodeSinkInfoProvider</unmanaged>
|
|
<unmanaged-short>IMFTranscodeSinkInfoProvider</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TranscodeSinkInfoProvider"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TranscodeSinkInfoProvider">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TranscodeSinkInfoProvider"/>. (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.MediaFoundation.TranscodeSinkInfoProvider.SetOutputFile(System.String)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets the name of the encoded output file.</p>
|
|
</summary>
|
|
<param name="wszFileNameRef"><dd> <p>Pointer to a null-terminated string that contains the name of the output file.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> The media sink will create a local file with the specified file name.</p><p>Alternately, you can call <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetOutputByteStream(SharpDX.MediaFoundation.Activate)"/></strong> to specify a byte stream that will receive the transcoded data. These two methods are mutually exclusive.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeSinkInfoProvider::SetOutputFile']/*"/>
|
|
<msdn-id>dd369149</msdn-id>
|
|
<unmanaged>HRESULT IMFTranscodeSinkInfoProvider::SetOutputFile([In] const wchar_t* pwszFileName)</unmanaged>
|
|
<unmanaged-short>IMFTranscodeSinkInfoProvider::SetOutputFile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetOutputByteStream(SharpDX.MediaFoundation.Activate)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets an output byte stream for the transcode media sink.</p>
|
|
</summary>
|
|
<param name="byteStreamActivateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong> interface of a byte-stream activation object. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Call this method to provide a writeable byte stream that will receive the transcoded data.</p><p>Alternatively, you can provide the name of an output file, by calling <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetOutputFile(System.String)"/></strong>. These two methods are mutually exclusive.</p><p>The <em>pByteStreamActivate</em> parameter must specify an activation object that creates a writeable byte stream. Internally, the transcode media sink calls <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> to create the byte stream, as follows:</p><code><see cref="T:SharpDX.MediaFoundation.ByteStream"/> *pByteStream = <c>null</c>; <see cref="T:SharpDX.Result"/> hr = pByteStreamActivate->ActivateObject(IID_IMFByteStream, (void**)&pByteStream);</code><p>Currently, Microsoft Media Foundation does not provide any byte-stream activation objects. To use this method, an application must provide a custom implementation of <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeSinkInfoProvider::SetOutputByteStream']/*"/>
|
|
<msdn-id>dd369148</msdn-id>
|
|
<unmanaged>HRESULT IMFTranscodeSinkInfoProvider::SetOutputByteStream([In] IMFActivate* pByteStreamActivate)</unmanaged>
|
|
<unmanaged-short>IMFTranscodeSinkInfoProvider::SetOutputByteStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetProfile(SharpDX.MediaFoundation.TranscodeProfile)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets the transcoding profile on the transcode sink activation object.</p>
|
|
</summary>
|
|
<param name="profileRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.TranscodeProfile"/></strong> interface. To get a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTranscodeProfile(SharpDX.MediaFoundation.TranscodeProfile@)"/></strong>.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Before calling this method, initialize the profile object as follows:</p><ul> <li>Set the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute to specify the container type of the output file.</li> <li>If the output file will have a video stream, set video attributes by calling the <strong><see cref="M:SharpDX.MediaFoundation.TranscodeProfile.SetVideoAttributes(SharpDX.MediaFoundation.MediaAttributes)"/></strong> method.</li> <li>If the output file will have an audio stream, set audio attributes by calling the <strong><see cref="M:SharpDX.MediaFoundation.TranscodeProfile.SetAudioAttributes(SharpDX.MediaFoundation.MediaAttributes)"/></strong> method.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeSinkInfoProvider::SetProfile']/*"/>
|
|
<msdn-id>dd369150</msdn-id>
|
|
<unmanaged>HRESULT IMFTranscodeSinkInfoProvider::SetProfile([In] IMFTranscodeProfile* pProfile)</unmanaged>
|
|
<unmanaged-short>IMFTranscodeSinkInfoProvider::SetProfile</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.GetSinkInfo(SharpDX.MediaFoundation.TranscodeSinkInformation@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the media types for the audio and video streams specified in the transcode profile.</p>
|
|
</summary>
|
|
<param name="sinkInfoRef"><dd> <p>A reference to an <strong><see cref="T:SharpDX.MediaFoundation.TranscodeSinkInformation"/></strong> structure.</p> <p>If the method succeeds, the method assigns <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> references to the <strong>pAudioMediaType</strong> and <strong>pVideoMediaType</strong> members of this structure. The method might set either member to <strong><c>null</c></strong>. If either member is non-<c>null</c> after the method returns, the caller must release the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> references.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Before calling this method, call <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetProfile(SharpDX.MediaFoundation.TranscodeProfile)"/></strong> to set the transcode profile. The <strong>GetSinkInfo</strong> method uses the profile to create media types for the audio and video streams. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeSinkInfoProvider::GetSinkInfo']/*"/>
|
|
<msdn-id>dd369147</msdn-id>
|
|
<unmanaged>HRESULT IMFTranscodeSinkInfoProvider::GetSinkInfo([Out] MF_TRANSCODE_SINK_INFO* pSinkInfo)</unmanaged>
|
|
<unmanaged-short>IMFTranscodeSinkInfoProvider::GetSinkInfo</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.OutputFile">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets the name of the encoded output file.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> The media sink will create a local file with the specified file name.</p><p>Alternately, you can call <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetOutputByteStream(SharpDX.MediaFoundation.Activate)"/></strong> to specify a byte stream that will receive the transcoded data. These two methods are mutually exclusive.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeSinkInfoProvider::SetOutputFile']/*"/>
|
|
<msdn-id>dd369149</msdn-id>
|
|
<unmanaged>SetOutputFile</unmanaged>
|
|
<unmanaged-short>SetOutputFile</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTranscodeSinkInfoProvider::SetOutputFile([In] const wchar_t* pwszFileName)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.OutputByteStream">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets an output byte stream for the transcode media sink.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Call this method to provide a writeable byte stream that will receive the transcoded data.</p><p>Alternatively, you can provide the name of an output file, by calling <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetOutputFile(System.String)"/></strong>. These two methods are mutually exclusive.</p><p>The <em>pByteStreamActivate</em> parameter must specify an activation object that creates a writeable byte stream. Internally, the transcode media sink calls <strong><see cref="M:SharpDX.MediaFoundation.Activate.ActivateObject(System.Guid,System.IntPtr@)"/></strong> to create the byte stream, as follows:</p><code><see cref="T:SharpDX.MediaFoundation.ByteStream"/> *pByteStream = <c>null</c>; <see cref="T:SharpDX.Result"/> hr = pByteStreamActivate->ActivateObject(IID_IMFByteStream, (void**)&pByteStream);</code><p>Currently, Microsoft Media Foundation does not provide any byte-stream activation objects. To use this method, an application must provide a custom implementation of <strong><see cref="T:SharpDX.MediaFoundation.Activate"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeSinkInfoProvider::SetOutputByteStream']/*"/>
|
|
<msdn-id>dd369148</msdn-id>
|
|
<unmanaged>SetOutputByteStream</unmanaged>
|
|
<unmanaged-short>SetOutputByteStream</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTranscodeSinkInfoProvider::SetOutputByteStream([In] IMFActivate* pByteStreamActivate)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.Profile">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets the transcoding profile on the transcode sink activation object.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Before calling this method, initialize the profile object as follows:</p><ul> <li>Set the <see cref="F:SharpDX.MediaFoundation.TranscodeAttributeKeys.TranscodeContainertype"/> attribute to specify the container type of the output file.</li> <li>If the output file will have a video stream, set video attributes by calling the <strong><see cref="M:SharpDX.MediaFoundation.TranscodeProfile.SetVideoAttributes(SharpDX.MediaFoundation.MediaAttributes)"/></strong> method.</li> <li>If the output file will have an audio stream, set audio attributes by calling the <strong><see cref="M:SharpDX.MediaFoundation.TranscodeProfile.SetAudioAttributes(SharpDX.MediaFoundation.MediaAttributes)"/></strong> method.</li> </ul>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeSinkInfoProvider::SetProfile']/*"/>
|
|
<msdn-id>dd369150</msdn-id>
|
|
<unmanaged>SetProfile</unmanaged>
|
|
<unmanaged-short>SetProfile</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTranscodeSinkInfoProvider::SetProfile([In] IMFTranscodeProfile* pProfile)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SinkInfo">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the media types for the audio and video streams specified in the transcode profile.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Before calling this method, call <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.SetProfile(SharpDX.MediaFoundation.TranscodeProfile)"/></strong> to set the transcode profile. The <strong>GetSinkInfo</strong> method uses the profile to create media types for the audio and video streams. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTranscodeSinkInfoProvider::GetSinkInfo']/*"/>
|
|
<msdn-id>dd369147</msdn-id>
|
|
<unmanaged>GetSinkInfo</unmanaged>
|
|
<unmanaged-short>GetSinkInfo</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTranscodeSinkInfoProvider::GetSinkInfo([Out] MF_TRANSCODE_SINK_INFO* pSinkInfo)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Transform">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Implemented by all Media Foundation Transforms (MFTs).</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform']/*"/>
|
|
<msdn-id>ms696260</msdn-id>
|
|
<unmanaged>IMFTransform</unmanaged>
|
|
<unmanaged-short>IMFTransform</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.Transform"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.Transform">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.Transform"/>. (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.MediaFoundation.Transform.GetStreamLimits(System.Int32@,System.Int32@,System.Int32@,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the minimum and maximum number of input and output streams for this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwInputMinimumRef"><dd> <p> Receives the minimum number of input streams. </p> </dd></param>
|
|
<param name="dwInputMaximumRef"><dd> <p> Receives the maximum number of input streams. If there is no maximum, receives the value <strong>MFT_STREAMS_UNLIMITED</strong>. </p> </dd></param>
|
|
<param name="dwOutputMinimumRef"><dd> <p> Receives the minimum number of output streams. </p> </dd></param>
|
|
<param name="dwOutputMaximumRef"><dd> <p> Receives the maximum number of output streams. If there is no maximum, receives the value <strong>MFT_STREAMS_UNLIMITED</strong>. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> If the MFT has a fixed number of streams, the minimum and maximum values are the same. </p><p> It is not recommended to create an MFT that supports zero inputs or zero outputs. An MFT with no inputs or no outputs may not be compatible with the rest of the Media Foundation pipeline. You should create a Media Foundation sink or source for this purpose instead. </p><p> When an MFT is first created, it is not guaranteed to have the minimum number of streams. To find the actual number of streams, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamCount(System.Int32@,System.Int32@)"/></strong>. </p><p> This method should not be called with <strong><c>null</c></strong> parameters, although in practice some implementations may allow <strong><c>null</c></strong> parameters. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetStreamLimits</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetStreamLimits']/*"/>
|
|
<msdn-id>ms697040</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetStreamLimits([Out] unsigned int* pdwInputMinimum,[Out] unsigned int* pdwInputMaximum,[Out] unsigned int* pdwOutputMinimum,[Out] unsigned int* pdwOutputMaximum)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetStreamLimits</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetStreamCount(System.Int32@,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the current number of input and output streams on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="cInputStreamsRef"><dd> <p> Receives the number of input streams. </p> </dd></param>
|
|
<param name="cOutputStreamsRef"><dd> <p> Receives the number of output streams. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p> The number of streams includes unselected streams?that is, streams with no media type or a <strong><c>null</c></strong> media type.</p><p> This method should not be called with <strong><c>null</c></strong> parameters, although in practice some implementations may allow <strong><c>null</c></strong> parameters. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetStreamCount</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetStreamCount']/*"/>
|
|
<msdn-id>ms697018</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetStreamCount([Out] unsigned int* pcInputStreams,[Out] unsigned int* pcOutputStreams)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetStreamCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the stream identifiers for the input and output streams on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwInputIDArraySize"><dd> <p> Number of elements in the <em>pdwInputIDs</em> array. </p> </dd></param>
|
|
<param name="dwInputIDsRef"><dd> <p> Pointer to an array allocated by the caller. The method fills the array with the input stream identifiers. The array size must be at least equal to the number of input streams. To get the number of input streams, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamCount(System.Int32@,System.Int32@)"/></strong>. </p> <p>If the caller passes an array that is larger than the number of input streams, the MFT must not write values into the extra array entries.</p> </dd></param>
|
|
<param name="dwOutputIDArraySize"><dd> <p> Number of elements in the <em>pdwOutputIDs</em> array. </p> </dd></param>
|
|
<param name="dwOutputIDsRef"><dd> <p> Pointer to an array allocated by the caller. The method fills the array with the output stream identifiers. The array size must be at least equal to the number of output streams. To get the number of output streams, call <strong>GetStreamCount</strong>. </p> <p>If the caller passes an array that is larger than the number of output streams, the MFT must not write values into the extra array entries.</p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> Not implemented. See Remarks. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BUFFERTOOSMALL</strong></dt> </dl> </td><td> <p> One or both of the arrays is too small. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> Stream identifiers are necessary because some MFTs can add or remove streams, so the index of a stream may not be unique. Therefore, <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> methods that operate on streams take stream identifiers. </p><p>This method can return <strong>E_NOTIMPL</strong> if both of the following conditions are true:</p><ul> <li> The transform has a fixed number of streams. </li> <li> The streams are numbered consecutively from 0 to n ? 1, where n is the number of input streams or output streams. In other words, the first input stream is 0, the second is 1, and so on; and the first output stream is 0, the second is 1, and so on. </li> </ul><p>This method must be implemented if any of the following conditions is true:</p><ul> <li> The MFT can add or remove output streams. </li> <li> The MFT allows the client to add or remove input streams. </li> <li> The stream identifiers are not consecutive. </li> </ul><p> All input stream identifiers must be unique within an MFT, and all output stream identifiers must be unique. However, an input stream and an output stream can share the same identifier. </p><p> If the client adds an input stream, the client assigns the identifier, so the MFT must allow arbitrary identifiers, as long as they are unique. If the MFT creates an output stream, the MFT assigns the identifier. </p><p> By convention, if an MFT has exactly one fixed input stream and one fixed output stream, it should assign the identifier 0 to both streams. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetStreamIDs</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetStreamIDs']/*"/>
|
|
<msdn-id>ms693988</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetStreamIDs([In] unsigned int dwInputIDArraySize,[Out, Buffer] unsigned int* pdwInputIDs,[In] unsigned int dwOutputIDArraySize,[Out, Buffer] unsigned int* pdwOutputIDs)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetStreamIDs</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetInputStreamInfo(System.Int32,SharpDX.MediaFoundation.TInputStreamInformation@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the buffer requirements and other information for an input stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwInputStreamID"><dd> <p> Input stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="streamInfoRef"><dd> <p> Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.TInputStreamInformation"/></strong> structure. The method fills the structure with information about the input stream. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>It is valid to call this method before setting the media types.</p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetInputStreamInfo</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetInputStreamInfo']/*"/>
|
|
<msdn-id>ms703894</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetInputStreamInfo([In] unsigned int dwInputStreamID,[Out] MFT_INPUT_STREAM_INFO* pStreamInfo)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetInputStreamInfo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetOutputStreamInfo(System.Int32,SharpDX.MediaFoundation.TOutputStreamInformation@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the buffer requirements and other information for an output stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwOutputStreamID"><dd> <p> Output stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="streamInfoRef"><dd> <p> Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.TOutputStreamInformation"/></strong> structure. The method fills the structure with information about the output stream. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream number. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>It is valid to call this method before setting the media types.</p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetOutputStreamInfo</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetOutputStreamInfo']/*"/>
|
|
<msdn-id>ms693880</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetOutputStreamInfo([In] unsigned int dwOutputStreamID,[Out] MFT_OUTPUT_STREAM_INFO* pStreamInfo)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetOutputStreamInfo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetAttributes(SharpDX.MediaFoundation.MediaAttributes@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the global attribute store for this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="attributesRef"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> The MFT does not support attributes. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> Use the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> reference retrieved by this method to get or set attributes that apply to the entire MFT. To get the attribute store for an input stream, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetInputStreamAttributes(System.Int32,SharpDX.MediaFoundation.MediaAttributes@)"/></strong>. To get the attribute store for an output stream, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputStreamAttributes(System.Int32,SharpDX.MediaFoundation.MediaAttributes@)"/></strong>. </p><p> Implementation of this method is optional unless the MFT needs to support a particular set of attributes. Exception: Hardware-based MFTs must implement this method. See Hardware MFTs.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetAttributes']/*"/>
|
|
<msdn-id>ms703141</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetAttributes([Out] IMFAttributes** pAttributes)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetInputStreamAttributes(System.Int32,SharpDX.MediaFoundation.MediaAttributes@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the attribute store for an input stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwInputStreamID"><dd> <p> Input stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="attributesRef"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> The MFT does not support input stream attributes. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> Implementation of this method is optional unless the MFT needs to support a particular set of attributes. </p><p> To get the attribute store for the entire MFT, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetAttributes(SharpDX.MediaFoundation.MediaAttributes@)"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetInputStreamAttributes']/*"/>
|
|
<msdn-id>ms695366</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetInputStreamAttributes([In] unsigned int dwInputStreamID,[Out] IMFAttributes** pAttributes)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetInputStreamAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetOutputStreamAttributes(System.Int32,SharpDX.MediaFoundation.MediaAttributes@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the attribute store for an output stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwOutputStreamID"><dd> <p> Output stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="attributesRef"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> The MFT does not support output stream attributes. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> Implementation of this method is optional unless the MFT needs to support a particular set of attributes. </p><p> To get the attribute store for the entire MFT, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetAttributes(SharpDX.MediaFoundation.MediaAttributes@)"/></strong>. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetOutputStreamAttributes']/*"/>
|
|
<msdn-id>ms703886</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetOutputStreamAttributes([In] unsigned int dwOutputStreamID,[Out] IMFAttributes** pAttributes)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetOutputStreamAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.DeleteInputStream(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Removes an input stream from this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwStreamID"><dd> <p> Identifier of the input stream to remove. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> The transform has a fixed number of input streams. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p> The stream is not removable, or the transform currently has the minimum number of input streams it can support. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_INPUT_REMAINING</strong></dt> </dl> </td><td> <p> The transform has unprocessed input buffers for the specified stream. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If the transform has a fixed number of input streams, the method returns <strong>E_NOTIMPL</strong>. </p><p> An MFT might support this method but not allow certain input streams to be removed. If an input stream can be removed, the <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetInputStreamInfo(System.Int32,SharpDX.MediaFoundation.TInputStreamInformation@)"/></strong> method returns the <strong><see cref="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.MftInputStreamRemovable"/></strong> flag for that stream. Otherwise, the stream cannot be removed, and the method returns <strong>MF_E_INVALIDREQUEST</strong>. The method also fails if the MFT currently has the minimum number of input streams that it requires. To find the minimum number of streams, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamLimits(System.Int32@,System.Int32@,System.Int32@,System.Int32@)"/></strong>. </p><p> If the transform still has unprocessed input for that stream, the method might succeed or it might return <strong>MF_E_TRANSFORM_INPUT_REMAINING</strong>. If the method succeeds, the MFT will continue to process the remaining input after the stream is removed. If the method returns <strong>MF_E_TRANSFORM_INPUT_REMAINING</strong>, you must clear the input buffers before removing the stream. To clear the input buffers, either call <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong> or else call <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessMessage(SharpDX.MediaFoundation.TMessageType,System.IntPtr)"/></strong> with the <strong><see cref="F:SharpDX.MediaFoundation.TMessageType.CommandFlush"/></strong> to flush the MFT. Then call the <strong>DeleteInputStream</strong> again. An MFT should never discard input buffers when <strong>DeleteInputStream</strong> is called. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTDeleteInputStream</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::DeleteInputStream']/*"/>
|
|
<msdn-id>ms703159</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::DeleteInputStream([In] unsigned int dwStreamID)</unmanaged>
|
|
<unmanaged-short>IMFTransform::DeleteInputStream</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.AddInputStreams(System.Int32,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Adds one or more new input streams to this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="cStreams"><dd> <p> Number of streams to add. </p> </dd></param>
|
|
<param name="adwStreamIDs"><dd> <p> Array of stream identifiers. The new stream identifiers must not match any existing input streams. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> Invalid argument. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> The MFT has a fixed number of input streams. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If the new streams exceed the maximum number of input streams for this transform, the method returns <strong>E_INVALIDARG.</strong> To find the maximum number of input streams, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamLimits(System.Int32@,System.Int32@,System.Int32@,System.Int32@)"/></strong>. </p><p> If any of the new stream identifiers conflicts with an existing input stream, the method returns <strong>E_INVALIDARG</strong>. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTAddInputStreams</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::AddInputStreams']/*"/>
|
|
<msdn-id>ms696211</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::AddInputStreams([In] unsigned int cStreams,[In] unsigned int* adwStreamIDs)</unmanaged>
|
|
<unmanaged-short>IMFTransform::AddInputStreams</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetInputAvailableType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets an available media type for an input stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwInputStreamID"><dd> <p> Input stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="dwTypeIndex"><dd> <p> Index of the media type to retrieve. Media types are indexed from zero and returned in approximate order of preference. </p> </dd></param>
|
|
<param name="typeOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> The MFT does not have a list of available input types. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_MORE_TYPES</strong></dt> </dl> </td><td> <p> The <em>dwTypeIndex</em> parameter is out of range. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> You must set the output types before setting the input types. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> The MFT defines a list of available media types for each input stream and orders them by preference. This method enumerates the available media types for an input stream. To enumerate the available types, increment <em>dwTypeIndex</em> until the method returns <strong>MF_E_NO_MORE_TYPES</strong>. </p><p> Setting the media type on one stream might change the available types for another stream, or change the preference order. However, an MFT is not required to update the list of available types dynamically. The only guaranteed way to test whether you can set a particular input type is to call <strong><see cref="M:SharpDX.MediaFoundation.Transform.SetInputType(System.Int32,SharpDX.MediaFoundation.MediaType,System.Int32)"/></strong>. </p><p> In some cases, an MFT cannot return a list of input types until one or more output types are set. If so, the method returns <strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong>. </p><p> An MFT is not required to implement this method. However, most MFTs should implement this method, unless the supported types are simple and can be discovered through the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TGetInfo(System.Guid,System.IntPtr,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32@,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32@,SharpDX.MediaFoundation.MediaAttributes@)"/></strong> function.</p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetInputAvailableType</strong>. See Creating Hybrid DMO/MFT Objects.</p>Implementation Notes<p>If the MFT stores a media type internally, the MFT should return a clone of the media type, not a reference to the original type. Otherwise, the caller might modify the type and alter the internal state of the MFT.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetInputAvailableType']/*"/>
|
|
<msdn-id>ms704814</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetInputAvailableType([In] unsigned int dwInputStreamID,[In] unsigned int dwTypeIndex,[Out] IMFMediaType** ppType)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetInputAvailableType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetOutputAvailableType(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets an available media type for an output stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwOutputStreamID"><dd> <p> Output stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="dwTypeIndex"><dd> <p> Index of the media type to retrieve. Media types are indexed from zero and returned in approximate order of preference. </p> </dd></param>
|
|
<param name="typeOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> The MFT does not have a list of available output types. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_MORE_TYPES</strong></dt> </dl> </td><td> <p> The <em>dwTypeIndex</em> parameter is out of range. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> You must set the input types before setting the output types. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> The MFT defines a list of available media types for each output stream and orders them by preference. This method enumerates the available media types for an output stream. To enumerate the available types, increment <em>dwTypeIndex</em> until the method returns MF_<strong>E_NO_MORE_TYPES</strong>. </p><p> Setting the media type on one stream can change the available types for another stream (or change the preference order). However, an MFT is not required to update the list of available types dynamically. The only guaranteed way to test whether you can set a particular input type is to call <strong><see cref="M:SharpDX.MediaFoundation.Transform.SetOutputType(System.Int32,SharpDX.MediaFoundation.MediaType,System.Int32)"/></strong>. </p><p> In some cases, an MFT cannot return a list of output types until one or more input types are set. If so, the method returns <strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong>. </p><p> An MFT is not required to implement this method. However, most MFTs should implement this method, unless the supported types are simple and can be discovered through the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.TGetInfo(System.Guid,System.IntPtr,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32@,SharpDX.MediaFoundation.TRegisterTypeInformation[],System.Int32@,SharpDX.MediaFoundation.MediaAttributes@)"/></strong> function. </p><p> This method can return a <em>partial</em> media type. A partial media type contains an incomplete description of a format, and is used to provide a hint to the caller. For example, a partial type might include just the major type and subtype GUIDs. However, after the client sets the input types on the MFT, the MFT should generally return at least one complete output type, which can be used without further modification. For more information, see Complete and Partial Media Types.</p><p>Some MFTs cannot provide an accurate list of output types until the MFT receives the first input sample. For example, the MFT might need to read the first packet header to deduce the format. An MFT should handle this situation as follows:</p><ol> <li> Before the MFT receives any input, it offers a list of one or more output types that it could possibly produce. For example, an MPEG-2 decoder might return a media type that describes the MPEG-2 main profile/main level. </li> <li> The client selects one of these types (generally the first) and sets it on the output stream. </li> <li> The client delivers the first input sample by calling <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessInput(System.Int32,SharpDX.MediaFoundation.Sample,System.Int32)"/></strong>. </li> <li> If the output type does not conform to the input data, the transform signals a format change in the <strong>ProcessOutput</strong> method. For more information about format changes, see <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong>. </li> <li> The calls <strong>GetOutputAvailableType</strong> again. At this point, the method should return an updated list of types that reflects the input data. </li> <li> The client selects a new output type from this list and calls <strong>SetOutputType</strong>. </li> </ol><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetOutputAvailableType</strong>. See Creating Hybrid DMO/MFT Objects.</p>Implementation Notes<p>If the MFT stores a media type internally, the MFT should return a clone of the media type, not a reference to the original type. Otherwise, the caller might modify the type and alter the internal state of the MFT.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetOutputAvailableType']/*"/>
|
|
<msdn-id>ms703812</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetOutputAvailableType([In] unsigned int dwOutputStreamID,[In] unsigned int dwTypeIndex,[Out] IMFMediaType** ppType)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetOutputAvailableType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.SetInputType(System.Int32,SharpDX.MediaFoundation.MediaType,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sets, tests, or clears the media type for an input stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwInputStreamID"><dd> <p> Input stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="typeRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface, or <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="dwFlags"><dd> <p> Zero or more flags from the <strong>_MFT_SET_TYPE_FLAGS</strong> enumeration. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDMEDIATYPE</strong></dt> </dl> </td><td> <p> The MFT cannot use the proposed media type. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDTYPE</strong></dt> </dl> </td><td> <p> The proposed type is not valid. This error code indicates that the media type itself is not configured correctly; for example, it might contain mutually contradictory attributes. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_CANNOT_CHANGE_MEDIATYPE_WHILE_PROCESSING</strong></dt> </dl> </td><td> <p> The MFT cannot switch types while processing data. Try draining or flushing the MFT. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> You must set the output types before setting the input types. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_D3D_TYPE</strong></dt> </dl> </td><td> <p> The MFT could not find a suitable DirectX Video Acceleration (DXVA) configuration. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method can be used to set, test without setting, or clear the media type:</p><ul> <li> To set the media type, set <em>dwFlags</em> to zero and set <em>pType</em> to a non-<strong><c>null</c></strong> reference that specifies the media type. </li> <li> To test the media type without setting it, set <em>dwFlags</em> to <strong><see cref="F:SharpDX.MediaFoundation.MftSetTypeFlags.MftSetTypeTestOnly"/></strong> and set <em>pType</em> to a non-<strong><c>null</c></strong> reference that specifies the media type. If the media type is acceptable, the method return <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns <strong>MF_E_INVALIDMEDIATYPE</strong>. Regardless of the return value, the current media type does not change. </li> <li> To clear the media type, set <em>pType</em> to <strong><c>null</c></strong>. </li> </ul><p> Setting the media type on one stream may change the acceptable types on another stream. </p><p> An MFT may require the caller to set one or more output types before setting the input type. If so, the method returns <strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong>. </p><p> If the MFT supports DirectX Video Acceleration (DXVA) but is unable to find a suitable DXVA configuration (for example, if the graphics driver does not have the right capabilities), the method should return <strong>MF_E_UNSUPPORTED_D3D_TYPE</strong>. For more information, see Supporting DXVA 2.0 in Media Foundation. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTSetInputType</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::SetInputType']/*"/>
|
|
<msdn-id>ms700113</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::SetInputType([In] unsigned int dwInputStreamID,[In, Optional] IMFMediaType* pType,[In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IMFTransform::SetInputType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.SetOutputType(System.Int32,SharpDX.MediaFoundation.MediaType,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sets, tests, or clears the media type for an output stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwOutputStreamID"><dd> <p> Output stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="typeRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface, or <strong><c>null</c></strong>. </p> </dd></param>
|
|
<param name="dwFlags"><dd> <p> Zero or more flags from the <strong>_MFT_SET_TYPE_FLAGS</strong> enumeration. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDMEDIATYPE</strong></dt> </dl> </td><td> <p> The transform cannot use the proposed media type. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDTYPE</strong></dt> </dl> </td><td> <p> The proposed type is not valid. This error code indicates that the media type itself is not configured correctly; for example, it might contain mutually contradictory flags. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_CANNOT_CHANGE_MEDIATYPE_WHILE_PROCESSING</strong></dt> </dl> </td><td> <p> The MFT cannot switch types while processing data. Try draining or flushing the MFT. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> You must set the input types before setting the output types. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_D3D_TYPE</strong></dt> </dl> </td><td> <p> The MFT could not find a suitable DirectX Video Acceleration (DXVA) configuration. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method can be used to set, test without setting, or clear the media type:</p><ul> <li> To set the media type, set <em>dwFlags</em> to zero and set <em>pType</em> to a non-<strong><c>null</c></strong> reference that specifies the media type. </li> <li> To test the media type without setting it, set <em>dwFlags</em> to <strong><see cref="F:SharpDX.MediaFoundation.MftSetTypeFlags.MftSetTypeTestOnly"/></strong> and set <em>pType</em> to a non-<strong><c>null</c></strong> reference that specifies the media type. If the media type is acceptable, the method return <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns <strong>MF_E_INVALIDMEDIATYPE</strong>. Regardless of the return value, the current media type does not change. </li> <li> To clear the media type, set <em>pType</em> to <strong><c>null</c></strong>. </li> </ul><p> Setting the media type on one stream may change the acceptable types on another stream. </p><p> An MFT may require the caller to set one or more input types before setting the output type. If so, the method returns <strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong>. </p><p>If the MFT supports DirectX Video Acceleration (DXVA) but is unable to find a suitable DXVA configuration (for example, if the graphics driver does not have the right capabilities), the method should return <strong>MF_E_UNSUPPORTED_D3D_TYPE</strong>. For more information, see Supporting DXVA 2.0 in Media Foundation.</p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTSetOutputType</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::SetOutputType']/*"/>
|
|
<msdn-id>ms702016</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::SetOutputType([In] unsigned int dwOutputStreamID,[In, Optional] IMFMediaType* pType,[In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IMFTransform::SetOutputType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetInputCurrentType(System.Int32,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the current media type for an input stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwInputStreamID"><dd> <p> Input stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="typeOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> The input media type has not been set. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If the specified input stream does not yet have a media type, the method returns <strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong>. Most MFTs do not set any default media types when first created. Instead, the client must set the media type by calling <strong><see cref="M:SharpDX.MediaFoundation.Transform.SetInputType(System.Int32,SharpDX.MediaFoundation.MediaType,System.Int32)"/></strong>. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetInputCurrentType</strong>. See Creating Hybrid DMO/MFT Objects.</p>Implementation Notes<p>The MFT should return a clone of the media type, not a reference to the original type. Otherwise, the caller might modify the type and alter the internal state of the MFT.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetInputCurrentType']/*"/>
|
|
<msdn-id>ms705607</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetInputCurrentType([In] unsigned int dwInputStreamID,[Out] IMFMediaType** ppType)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetInputCurrentType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetOutputCurrentType(System.Int32,SharpDX.MediaFoundation.MediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the current media type for an output stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwOutputStreamID"><dd> <p> Output stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="typeOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface. The caller must release the interface. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> The output media type has not been set. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If the specified output stream does not yet have a media type, the method returns <strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong>. Most MFTs do not set any default media types when first created. Instead, the client must set the media type by calling <strong><see cref="M:SharpDX.MediaFoundation.Transform.SetOutputType(System.Int32,SharpDX.MediaFoundation.MediaType,System.Int32)"/></strong>. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetOutputCurrentType</strong>. See Creating Hybrid DMO/MFT Objects.</p>Implementation Notes<p>The MFT should return a clone of the media type, not a reference to the original type. Otherwise, the caller might modify the type and alter the internal state of the MFT.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetOutputCurrentType']/*"/>
|
|
<msdn-id>ms696985</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetOutputCurrentType([In] unsigned int dwOutputStreamID,[Out] IMFMediaType** ppType)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetOutputCurrentType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetInputStatus(System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Queries whether an input stream on this Media Foundation transform (MFT) can accept more data. </p>
|
|
</summary>
|
|
<param name="dwInputStreamID"><dd> <p> Input stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="dwFlagsRef"><dd> <p> Receives a member of the <strong>_MFT_INPUT_STATUS_FLAGS</strong> enumeration, or zero. If the value is <strong><see cref="F:SharpDX.MediaFoundation.MftInputStatusFlags.MftInputStatusAcceptData"/></strong>, the stream specified in <em>dwInputStreamID</em> can accept more input data. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> The media type is not set on one or more streams. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If the method returns the <strong><see cref="F:SharpDX.MediaFoundation.MftInputStatusFlags.MftInputStatusAcceptData"/></strong> flag, you can deliver an input sample to the specified stream by calling <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessInput(System.Int32,SharpDX.MediaFoundation.Sample,System.Int32)"/></strong>. If the method succeeds but does not return any flags in the <em>pdwFlags</em> parameter, it means the input stream already has as much data as it can accept. </p><p> Use this method to test whether the input stream is ready to accept more data, without incurring the overhead of allocating a new sample and calling <strong>ProcessInput</strong>. </p><p> After the client has set valid media types on all of the streams, the MFT should always be in one of two states: Able to accept more input, or able to produce more output (or both). </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetInputStatus</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetInputStatus']/*"/>
|
|
<msdn-id>ms697478</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetInputStatus([In] unsigned int dwInputStreamID,[Out] unsigned int* pdwFlags)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetInputStatus</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.GetOutputStatus(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Queries whether the Media Foundation transform (MFT) is ready to produce output data. </p>
|
|
</summary>
|
|
<param name="dwFlagsRef"><dd> <p> Receives a member of the <strong>_MFT_OUTPUT_STATUS_FLAGS</strong> enumeration, or zero. If the value is <strong><see cref="F:SharpDX.MediaFoundation.MftOutputStatusFlags.MftOutputStatusSampleReady"/></strong>, the MFT can produce an output sample. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> Not implemented. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> The media type is not set on one or more streams. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> If the method returns the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputStatusFlags.MftOutputStatusSampleReady"/></strong> flag, it means you can generate one or more output samples by calling <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong>. </p><p> MFTs are not required to implement this method. If the method returns <strong>E_NOTIMPL</strong>, you must call <strong>ProcessOutput</strong> to determine whether the transform has output data. </p><p> If the MFT has more than one output stream, but it does not produce samples at the same time for each stream, it can set the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputStatusFlags.MftOutputStatusSampleReady"/></strong> flag when just one stream is ready. However, if the MFT normally produces samples at the same time for each output stream, it should not set this flag until all streams are ready. </p><p> After the client has set valid media types on all of the streams, the MFT should always be in one of two states: Able to accept more input, or able to produce more output. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetOutputStatus</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetOutputStatus']/*"/>
|
|
<msdn-id>ms696269</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::GetOutputStatus([Out] unsigned int* pdwFlags)</unmanaged>
|
|
<unmanaged-short>IMFTransform::GetOutputStatus</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.SetOutputBounds(System.Int64,System.Int64)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sets the range of time stamps the client needs for output. </p>
|
|
</summary>
|
|
<param name="hnsLowerBound"><dd> <p> Specifies the earliest time stamp. The Media Foundation transform (MFT) will accept input until it can produce an output sample that begins at this time; or until it can produce a sample that ends at this time or later. If there is no lower bound, use the value <strong>MFT_OUTPUT_BOUND_LOWER_UNBOUNDED</strong>. </p> </dd></param>
|
|
<param name="hnsUpperBound"><dd> <p> Specifies the latest time stamp. The MFT will not produce an output sample with time stamps later than this time. If there is no upper bound, use the value <strong>MFT_OUTPUT_BOUND_UPPER_UNBOUNDED</strong>. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> Not implemented. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> The media type is not set on one or more streams. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> This method can be used to optimize preroll, especially in formats that have gaps between time stamps, or formats where the data must start on a sync point, such as MPEG-2. Calling this method is optional, and implementation of this method by an MFT is optional. If the MFT does not implement the method, the return value is <strong>E_NOTIMPL</strong>.</p><p> If an MFT implements this method, it must limit its output data to the range of times specified by <em>hnsLowerBound</em> and <em>hnsUpperBound</em>. The MFT discards any input data that is not needed to produce output within this range. If the sample boundaries do not exactly match the range, the MFT should split the output samples, if possible. Otherwise, the output samples can overlap the range. </p><p> For example, suppose the output range is 100 to 150 milliseconds (ms), and the output format is video with each frame lasting 33 ms. A sample with a time stamp of 67 ms overlaps the range (67 + 33 = 100) and is produced as output. A sample with a time stamp of 66 ms is discarded (66 + 33 = 99). Similarly, a sample with a time stamp of 150 ms is produced as output, but a sample with a time stamp of 151 is discarded.</p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTSetOutputBounds</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::SetOutputBounds']/*"/>
|
|
<msdn-id>ms693812</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::SetOutputBounds([In] longlong hnsLowerBound,[In] longlong hnsUpperBound)</unmanaged>
|
|
<unmanaged-short>IMFTransform::SetOutputBounds</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.ProcessEvent(System.Int32,SharpDX.MediaFoundation.MediaEvent)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sends an event to an input stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwInputStreamID"><dd> <p> Input stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="eventRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaEvent"/></strong> interface of an event object. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_NOTIMPL</strong></dt> </dl> </td><td> <p> Not implemented. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream number. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> The media type is not set on one or more streams. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_S_TRANSFORM_DO_NOT_PROPAGATE_EVENT</strong></dt> </dl> </td><td> <p> The pipeline should not propagate the event. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> An MFT can handle sending the event downstream, or it can let the pipeline do this, as indicated by the return value: </p><ul> <li><strong>E_NOTIMPL</strong>: The MFT ignores all events, and the pipeline should send all events downstream. After the pipeline receives this return value, it might not call <strong>ProcessEvent</strong> again. </li> <li><strong><see cref="F:SharpDX.Result.Ok"/></strong>: The MFT has examined this event, but the pipeline should send the event downstream. Internally, the MFT might respond to the event in some way, or it might ignore the event. </li> <li><strong>MF_S_TRANSFORM_DO_NOT_PROPAGATE_EVENT</strong>: The pipeline should not propagate this event downstream. Either the MFT will send the event downstream, or else the MFT will consume the event and not send it downstream. The MFT should only consume the event if the event should stop at this MFT and not travel any further downstream. But in most cases, the event should travel downstream. </li> </ul><p> To send the event downstream, the MFT adds the event to the collection object that is provided by the client in the <strong>pEvents</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structure, when the client calls <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong>. </p><p> Events must be serialized with the samples that come before and after them. Attach the event to the output sample that follows the event. (The pipeline will process the event first, and then the sample.) If an MFT holds back one or more samples between calls to <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessInput(System.Int32,SharpDX.MediaFoundation.Sample,System.Int32)"/></strong> and <strong>ProcessOutput</strong>, the MFT should handle sending all events downstream, because in this situation the pipeline cannot correlate input samples with output samples. </p><p> If an MFT does not hold back samples and does not need to examine any events, it can return <strong>E_NOTIMPL</strong>. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTProcessEvent</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::ProcessEvent']/*"/>
|
|
<msdn-id>ms695394</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::ProcessEvent([In] unsigned int dwInputStreamID,[In, Optional] IMFMediaEvent* pEvent)</unmanaged>
|
|
<unmanaged-short>IMFTransform::ProcessEvent</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.ProcessMessage(SharpDX.MediaFoundation.TMessageType,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Sends a message to the Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="eMessage"><dd> <p> The message to send, specified as a member of the <strong><see cref="T:SharpDX.MediaFoundation.TMessageType"/></strong> enumeration. </p> </dd></param>
|
|
<param name="ulParam"><dd> <p> Message parameter. The meaning of this parameter depends on the message type. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream number. Applies to the <strong><see cref="F:SharpDX.MediaFoundation.TMessageType.NotifyEndOfStream"/></strong> message. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> The media type is not set on one or more streams. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> Before calling this method, set the media types on all input and output streams. </p><p> The MFT might ignore certain message types. If so, the method returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. An error code indicates that the transform handles this message type but was unable to process the message in this instance. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTProcessMessage</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::ProcessMessage']/*"/>
|
|
<msdn-id>ms701863</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::ProcessMessage([In] MFT_MESSAGE_TYPE eMessage,[In] ULONG_PTR ulParam)</unmanaged>
|
|
<unmanaged-short>IMFTransform::ProcessMessage</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.ProcessInput(System.Int32,SharpDX.MediaFoundation.Sample,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Delivers data to an input stream on this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<param name="dwInputStreamID"><dd> <p> Input stream identifier. To get the list of stream identifiers, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetStreamIDs(System.Int32,System.Int32[],System.Int32,System.Int32[])"/></strong>. </p> </dd></param>
|
|
<param name="sampleRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of the input sample. The sample must contain at least one media buffer that contains valid input data. </p> </dd></param>
|
|
<param name="dwFlags"><dd> <p> Reserved. Must be zero. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> Invalid argument. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_SAMPLE_DURATION</strong></dt> </dl> </td><td> <p>The input sample requires a valid sample duration. To set the duration, call <strong><see cref="M:SharpDX.MediaFoundation.Sample.SetSampleDuration(System.Int64)"/></strong>. </p> <p>Some MFTs require that input samples have valid durations. Some MFTs do not require sample durations.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NO_SAMPLE_TIMESTAMP</strong></dt> </dl> </td><td> <p>The input sample requires a time stamp. To set the time stamp, call <strong><see cref="M:SharpDX.MediaFoundation.Sample.SetSampleTime(System.Int64)"/></strong>. </p> <p>Some MFTs require that input samples have valid time stamps. Some MFTs do not require time stamps.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_NOTACCEPTING</strong></dt> </dl> </td><td> <p> The transform cannot process more input at this time. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> The media type is not set on one or more streams. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_UNSUPPORTED_D3D_TYPE</strong></dt> </dl> </td><td> <p> The media type is not supported for DirectX Video Acceleration (DXVA). A DXVA-enabled decoder might return this error code. </p> </td></tr> </table><p>?</p><p><strong>Note</strong>??If you are converting a DirectX Media Object (DMO) to an MFT, be aware that <strong>S_FALSE</strong> is not a valid return code for <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessInput(System.Int32,SharpDX.MediaFoundation.Sample,System.Int32)"/></strong>, unlike the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.ProcessInput(System.Int32,SharpDX.MediaFoundation.IMediaBuffer,System.Int32,System.Int64,System.Int64)"/></strong> method.</p></returns>
|
|
<remarks>
|
|
<p> In most cases, if the method succeeds, the MFT stores the sample and holds a reference count on the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> reference. Do not re-use the sample until the MFT releases the sample. Instead of storing the sample, however, an MFT might copy the sample data into a new buffer. In that case, the MFT should set the <strong><see cref="F:SharpDX.MediaFoundation.MftInputStreamInformationFlags.MftInputStreamDoesNotAddref"/></strong> flag in the <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetInputStreamInfo(System.Int32,SharpDX.MediaFoundation.TInputStreamInformation@)"/></strong> method. </p><p> If the MFT already has enough input data to produce an output sample, it does not accept new input data, and <strong>ProcessInput</strong> returns <strong>MF_E_NOTACCEPTING</strong>. At that point, the client should clear the pending input data by doing one of the following: </p><ul> <li> Generate new output by calling <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong>. </li> <li> Flush the input data by calling <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessMessage(SharpDX.MediaFoundation.TMessageType,System.IntPtr)"/></strong> with the MFT_<strong>MESSAGE_COMMAND_FLUSH</strong> message. </li> </ul><p> An exception to this rule is the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamLazyRead"/></strong> flag. When this flag is present, the transform will discard stored samples if you give it more input. For more information, see <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputStreamInfo(System.Int32,SharpDX.MediaFoundation.TOutputStreamInformation@)"/></strong>. A transform should never queue any more input data than is required to produce the correct output. </p><p> An MFT can process the input data in the <strong>ProcessInput</strong> method. However, most MFTs wait until the client calls <strong>ProcessOutput</strong>. </p><p> After the client has set valid media types on all of the streams, the MFT should always be in one of two states: Able to accept more input, or able to produce more output. It should never be in both states or neither state. An MFT should only accept as much input as it needs to generate at least one output sample, at which point <strong>ProcessInput</strong> returns <strong>MF_E_NOTACCEPTING</strong>. When <strong>ProcessInput</strong> returns <strong>MF_E_NOTACCEPTING</strong>, the client can assume that the MFT is ready to produce output. </p><p> If an MFT encounters a non-fatal error in the input data, it can simply drop the data and attempt to recover when it gets the more input data. To request more input data, the MFT returns <strong>MF_E_TRANSFORM_NEED_MORE_INPUT</strong> from the <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong> method. If the MFT drops any data, it should set the <strong><see cref="F:SharpDX.MediaFoundation.SampleAttributeKeys.Discontinuity"/></strong> attribute attribute on the next output sample, to notify the caller that there is a gap in the data stream. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTProcessInput</strong>. See Creating Hybrid DMO/MFT Objects.</p>Asynchronous Processing<p>The previous remarks describe the <em>synchronous</em> processing model. To support asynchronous processing, see Asynchronous MFTs.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::ProcessInput']/*"/>
|
|
<msdn-id>ms703131</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::ProcessInput([In] unsigned int dwInputStreamID,[In] IMFSample* pSample,[In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>IMFTransform::ProcessInput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Generates output from the current input data. </p>
|
|
</summary>
|
|
<param name="dwFlags"><dd> <p> Bitwise <strong>OR</strong> of zero or more flags from the <strong>_MFT_PROCESS_OUTPUT_FLAGS</strong> enumeration. </p> </dd></param>
|
|
<param name="cOutputBufferCount"><dd> <p> Number of elements in the <em>pOutputSamples</em> array. The value must be at least 1. </p> </dd></param>
|
|
<param name="outputSamplesRef"><dd> <p> Pointer to an array of <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structures, allocated by the caller. The MFT uses this array to return output data to the caller. </p> </dd></param>
|
|
<param name="dwStatusRef"><dd> <p> Receives a bitwise <strong>OR</strong> of zero or more flags from the <strong>_MFT_PROCESS_OUTPUT_STATUS</strong> enumeration. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_UNEXPECTED</strong></dt> </dl> </td><td> <p>The <strong>ProcessOutput</strong> method was called on an asynchronous MFT that was not expecting this method call.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier in the <strong>dwStreamID</strong> member of one or more <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structures. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_NEED_MORE_INPUT</strong></dt> </dl> </td><td> <p> The transform cannot produce output data until it receives more input data. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_STREAM_CHANGE</strong></dt> </dl> </td><td> <p> The format has changed on an output stream, or there is a new preferred format, or there is a new output stream. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_TRANSFORM_TYPE_NOT_SET</strong></dt> </dl> </td><td> <p> You must set the media type on one or more streams of the MFT. </p> </td></tr> </table><p>?</p><p><strong>Note</strong>??If you are converting a DirectX Media Object (DMO) to an MFT, be aware that <strong>S_FALSE</strong> is not a valid return code for <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong>, unlike the <strong><see cref="M:SharpDX.MediaFoundation.IMediaObject.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.DmoOutputDataBuffer[],System.Int32@)"/></strong> method.</p></returns>
|
|
<remarks>
|
|
<p> The size of the <em>pOutputSamples</em> array must be equal to or greater than the number of <em>selected</em> output streams. The number of selected output streams equals the total number of output streams minus the number of <em>deselected</em> streams. A stream is deselected if it has the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamOptional"/></strong> flag and the caller does not set a media type (or sets the media type to <strong><c>null</c></strong>). For more information, see <strong>_MFT_OUTPUT_STREAM_INFO_FLAGS</strong> enumeration. </p><p>This method generates output samples and can also generate events. If the method succeeds, at least one of the following conditions is true:</p><ul> <li> One or more samples in the <em>pOutputSamples</em> array contains output data. </li> <li> One or more members of the <em>pOutputSamples</em> array contains a non-empty collection of events. </li> </ul><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including Mftransform.h, this method is renamed <strong>MFTProcessOutput</strong>. See Creating Hybrid DMO/MFT Objects.</p>Output Buffers<p>The MFT returns output data for a stream through the <strong>pSample</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structure. This structure member is a reference to the <strong><see cref="T:SharpDX.MediaFoundation.Sample"/></strong> interface of a media sample. (See Media Samples.) The media sample is allocated either by the caller or by the MFT, depending on the MFT's allocation model. To find the allocation model, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputStreamInfo(System.Int32,SharpDX.MediaFoundation.TOutputStreamInformation@)"/></strong> and examine the <strong>dwFlags</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.TOutputStreamInformation"/></strong> structure:</p><ul> <li> If the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamProvidesSamples"/></strong> flag is present, the MFT allocates the media sample. </li> <li> If the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamCanProvideSamples"/></strong> flag is present, the caller can optionally provide a media sample. If <strong>pSample</strong> is <strong><c>null</c></strong>, the MFT will allocate the media sample. </li> <li> If neither of these two flags is present, the caller must allocate the media sample. </li> </ul><p>These flags remain constant unless the media type for the output stream changes.</p><p>If the caller allocates the media sample, the media sample must contain a buffer that is large enough to hold the output data. To find the buffer requirements, call <strong>GetOutputStreamInfo</strong>. The MFT writes the output data to the start of the buffer, overwriting any data that already exists in the buffer.</p><p>If the MFT allocates the sample, the MFT also allocates the buffers for the sample.</p><p>If the MFT has multiple output streams, the streams might produce output at different rates, so some streams might have output while other streams do not. If a stream did not any produce output, the MFT sets the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferNoSample"/></strong> flag in the <strong>dwStatus</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structure for that stream. In that case, if the caller allocated <strong>pSample</strong>, the buffers in the sample do not contain any valid data. If the caller did not allocate <strong>pSample</strong>, the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferNoSample"/></strong> flag indicates that <strong>pSample</strong> still equals <strong><c>null</c></strong> after the method returns.</p><p>If no output streams have data, and the MFT has no events to return, then <strong>ProcessOutput</strong> returns <strong>MF_E_TRANSFORM_NEED_MORE_INPUT</strong>.</p><p>The MFT cannot return more than one sample per stream in a single call to <strong>ProcessOutput</strong>. If there is more output data available for a stream after <strong>ProcessOutput</strong> returns, the MFT sets the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferIncomplete"/></strong> flag in the <strong>dwStatus</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structure for that stream.</p><p>If the MFT has enough data to produce output, it should refuse to accept any more input until <strong>ProcessOutput</strong> has been called enough times to pull all of the available output. (An exception is when the <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputStreamInfo(System.Int32,SharpDX.MediaFoundation.TOutputStreamInformation@)"/></strong> method returns the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamLazyRead"/></strong> flag.) Generally, an MFT with multiple output streams should produce output for a stream as soon as possible, and not wait for all of the streams to have output.</p>In-Band Events<p>The MFT can return a collection of event objects in the <strong>pEvents</strong> member of each <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structure. The MFT allocates both the collection object and the events.</p><p>To send an event to the caller, the MFT performs the following steps inside <strong>ProcessOutput</strong>:</p><ol> <li> Create a new collection object by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateCollection(SharpDX.MediaFoundation.Collection@)"/></strong>. </li> <li> Add one or more events to the collection by calling <strong><see cref="M:SharpDX.MediaFoundation.Collection.AddElement(SharpDX.ComObject)"/></strong>. </li> <li> Set the <strong>pEvents</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structure equal to the <strong><see cref="T:SharpDX.MediaFoundation.Collection"/></strong> reference. The MFT leaves a reference count on this interface; the caller must release the reference. </li> </ol><p>Events do not have time stamps. The caller should process the events before processing the output samples. In other words, events occur at the point in the stream immediately after the previous call to <strong>ProcessOutput</strong>, and prior to any output samples returned from the current <strong>ProcessOutput</strong> call.</p><p>It is valid for the <strong>ProcessOutput</strong> method to return one or more events and zero output samples.</p><p>The caller is responsible for releasing any events that the MFT allocates. When the method returns, check the <strong>pEvents</strong> member of each <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structure. If the value is not <strong><c>null</c></strong>, the caller must release the <strong><see cref="T:SharpDX.MediaFoundation.Collection"/></strong> interface reference:</p><pre>// Release the events that an MFT might allocate in <see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/>().
|
|
void ReleaseEventCollection(DWORD cOutputBuffers, <see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/>* pBuffers)
|
|
{ for (DWORD i = 0; i < cOutputBuffers; i++) { if (pBuffers[i].pEvents) { pBuffers[i].pEvents->Release(); pBuffers[i].pEvents = <c>null</c>; } }
|
|
}
|
|
</pre><p>An MFT should not use the <strong><see cref="T:SharpDX.MediaFoundation.MediaEventGenerator"/></strong> interface to send in-band events.</p>Stream Changes<p>The <strong>ProcessOutput</strong> method can cause any of the following changes in an output stream:</p><ul> <li> The deletion of an output stream. To signal a stream deletion, the MFT sets the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferStreamEnd"/></strong> flag in the <strong>dwStatus</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structure for that stream. </li> <li> The creation of a new output stream. To signal a new output stream, the MFT sets the <strong><see cref="F:SharpDX.MediaFoundation.MftProcessOutputStatus.MftProcessOutputStatusNewStreams"/></strong> flag in the <em>pdwStatus</em> parameter. A new stream can have the same stream identifier as a deleted stream. </li> <li> A format change on an output stream. To signal a format change, the MFT sets the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferFormatChange"/></strong> flag in the <strong>dwStatus</strong> member of the <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structure for that stream. </li> </ul><p>It is possible that all three of these actions will result from a single call to <strong>ProcessOutput</strong>. The caller must respond to them in the order listed here?first deletions, then additions, then format changes.</p><p>The <strong><see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferFormatChange"/></strong> flag signals a format change on an output stream. This might mean the current media type has become invalid, or the preference order has changed and a more efficient format is available. In the latter case, it is possible that the client will re-set the original media type. To guard against endless loops, the MFT should not set the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputDataBufferFlags.MftOutputDataBufferFormatChange"/></strong> flag again until there is another change. Also, avoid setting this flag if the preference order changes but the current media type is still the most preferred type.</p>Sample Attributes<p>An input sample might have attributes, which are accessed through the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. Unless a specific attribute no longer applies, all attributes should be copied into the corresponding output sample. The responsibily for copying attributes is determined as follows:</p><ul> <li> If the value of the <strong>MFPKEY_EXATTRIBUTE_SUPPORTED</strong> property on the MFT is <strong>VARIANT_TRUE</strong>, the MFT copies the attributes. </li> <li> If the value of <strong>MFPKEY_EXATTRIBUTE_SUPPORTED</strong> is <strong>VARIANT_FALSE</strong>, or the property is not set, the client must copy the sample attributes. Do not overwrite any attributes that the MFT sets on the output sample. </li> </ul><p>For a list of sample attributes, see Sample Attributes.</p>Asynchronous Processing<p>The previous remarks describe the <em>synchronous</em> processing model. To support asynchronous processing, see Asynchronous MFTs.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::ProcessOutput']/*"/>
|
|
<msdn-id>ms704014</msdn-id>
|
|
<unmanaged>HRESULT IMFTransform::ProcessOutput([In] unsigned int dwFlags,[In] unsigned int cOutputBufferCount,[In] MFT_OUTPUT_DATA_BUFFER* pOutputSamples,[In] unsigned int* pdwStatus)</unmanaged>
|
|
<unmanaged-short>IMFTransform::ProcessOutput</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Transform.Attributes">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets the global attribute store for this Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> Use the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> reference retrieved by this method to get or set attributes that apply to the entire MFT. To get the attribute store for an input stream, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetInputStreamAttributes(System.Int32,SharpDX.MediaFoundation.MediaAttributes@)"/></strong>. To get the attribute store for an output stream, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputStreamAttributes(System.Int32,SharpDX.MediaFoundation.MediaAttributes@)"/></strong>. </p><p> Implementation of this method is optional unless the MFT needs to support a particular set of attributes. Exception: Hardware-based MFTs must implement this method. See Hardware MFTs.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetAttributes']/*"/>
|
|
<msdn-id>ms703141</msdn-id>
|
|
<unmanaged>GetAttributes</unmanaged>
|
|
<unmanaged-short>GetAttributes</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTransform::GetAttributes([Out] IMFAttributes** pAttributes)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Transform.OutputStatus">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Queries whether the Media Foundation transform (MFT) is ready to produce output data. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> If the method returns the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputStatusFlags.MftOutputStatusSampleReady"/></strong> flag, it means you can generate one or more output samples by calling <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong>. </p><p> MFTs are not required to implement this method. If the method returns <strong>E_NOTIMPL</strong>, you must call <strong>ProcessOutput</strong> to determine whether the transform has output data. </p><p> If the MFT has more than one output stream, but it does not produce samples at the same time for each stream, it can set the <strong><see cref="F:SharpDX.MediaFoundation.MftOutputStatusFlags.MftOutputStatusSampleReady"/></strong> flag when just one stream is ready. However, if the MFT normally produces samples at the same time for each output stream, it should not set this flag until all streams are ready. </p><p> After the client has set valid media types on all of the streams, the MFT should always be in one of two states: Able to accept more input, or able to produce more output. </p><p>If <strong>MFT_UNIQUE_METHOD_NAMES</strong> is defined before including mftransform.h, this method is renamed <strong>MFTGetOutputStatus</strong>. See Creating Hybrid DMO/MFT Objects.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTransform::GetOutputStatus']/*"/>
|
|
<msdn-id>ms696269</msdn-id>
|
|
<unmanaged>GetOutputStatus</unmanaged>
|
|
<unmanaged-short>GetOutputStatus</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTransform::GetOutputStatus([Out] unsigned int* pdwFlags)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TrustedInput">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Implemented by components that provide input trust authorities (ITAs). This interface is used to get the ITA for each of the component's streams. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTrustedInput']/*"/>
|
|
<msdn-id>ms697279</msdn-id>
|
|
<unmanaged>IMFTrustedInput</unmanaged>
|
|
<unmanaged-short>IMFTrustedInput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedInput.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TrustedInput"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedInput.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TrustedInput">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TrustedInput"/>. (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.MediaFoundation.TrustedInput.GetInputTrustAuthority(System.Int32,System.Guid,SharpDX.ComObject@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Retrieves the input trust authority (ITA) for a specified stream.</p>
|
|
</summary>
|
|
<param name="dwStreamID"><dd> <p>The stream identifier for which the ITA is being requested.</p> </dd></param>
|
|
<param name="riid"><dd> <p>The interface identifier (IID) of the interface being requested. Currently the only supported value is IID_IMFInputTrustAuthority.</p> </dd></param>
|
|
<param name="unkObjectOut"><dd> <p>Receives a reference to the ITA's <strong><see cref="T:SharpDX.ComObject"/></strong> interface. The caller must release the interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_NOINTERFACE</strong></dt> </dl> </td><td> <p>The ITA does not expose the requested interface.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTrustedInput::GetInputTrustAuthority']/*"/>
|
|
<msdn-id>bb970501</msdn-id>
|
|
<unmanaged>HRESULT IMFTrustedInput::GetInputTrustAuthority([In] unsigned int dwStreamID,[In] const GUID& riid,[Out] IUnknown** ppunkObject)</unmanaged>
|
|
<unmanaged-short>IMFTrustedInput::GetInputTrustAuthority</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TrustedOutput">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Implemented by components that provide output trust authorities (OTAs). Any Media Foundation transform (MFT) or media sink that is designed to work within the protected media path (PMP) and also sends protected content outside the Media Foundation pipeline must implement this interface.</p><p>The policy engine uses this interface to negotiate what type of content protection should be applied to the content. Applications do not use this interface directly.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If an MFT supports <strong><see cref="T:SharpDX.MediaFoundation.TrustedOutput"/></strong>, it must expose the interface through <strong>QueryInterface</strong>. The interface applies to all of the input streams on the MFT. (There is no mechanism to return a separate <strong><see cref="T:SharpDX.MediaFoundation.TrustedOutput"/></strong> reference for each stream.) The MFT must apply the output policies to all of its input streams. If the MFT sends different streams to separate connectors, it must report all of the connector attributes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTrustedOutput']/*"/>
|
|
<msdn-id>ms694305</msdn-id>
|
|
<unmanaged>IMFTrustedOutput</unmanaged>
|
|
<unmanaged-short>IMFTrustedOutput</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedOutput.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TrustedOutput"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedOutput.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TrustedOutput">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TrustedOutput"/>. (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.MediaFoundation.TrustedOutput.GetOutputTrustAuthorityCount(System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="cOutputTrustAuthoritiesRef">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='IMFTrustedOutput::GetOutputTrustAuthorityCount']/*"/>
|
|
<unmanaged>HRESULT IMFTrustedOutput::GetOutputTrustAuthorityCount([Out] unsigned int* pcOutputTrustAuthorities)</unmanaged>
|
|
<unmanaged-short>IMFTrustedOutput::GetOutputTrustAuthorityCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedOutput.GetOutputTrustAuthorityByIndex(System.Int32,SharpDX.MediaFoundation.OutputTrustAuthority@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Gets an output trust authority (OTA), specified by index.</p>
|
|
</summary>
|
|
<param name="dwIndex"><dd> <p> Zero-based index of the OTA to retrieve. To get the number of OTAs provided by this object, call <strong><see cref="M:SharpDX.MediaFoundation.TrustedOutput.GetOutputTrustAuthorityCount(System.Int32@)"/></strong>. </p> </dd></param>
|
|
<param name="authorityOut"><dd> <p> Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.OutputTrustAuthority"/></strong> interface of the OTA. The caller must release the interface. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTrustedOutput::GetOutputTrustAuthorityByIndex']/*"/>
|
|
<msdn-id>bb970401</msdn-id>
|
|
<unmanaged>HRESULT IMFTrustedOutput::GetOutputTrustAuthorityByIndex([In] unsigned int dwIndex,[Out] IMFOutputTrustAuthority** ppauthority)</unmanaged>
|
|
<unmanaged-short>IMFTrustedOutput::GetOutputTrustAuthorityByIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedOutput.IsFinal_(System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Queries whether this output is a policy sink, meaning it handles the rights and restrictions required by the input trust authority (ITA).</p>
|
|
</summary>
|
|
<param name="fIsFinalRef"><dd> <p>Receives a Boolean value. If <strong>TRUE</strong>, this object is a policy sink. If <strong><see cref="F:SharpDX.Result.False"/></strong>, the policy must be enforced further downstream.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>A trusted output is generally considered to be a policy sink if it does not pass the media content that it receives anywhere else; or, if it does pass the media content elsewhere, either it protects the content using some proprietary method such as encryption, or it sufficiently devalues the content so as not to require protection.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTrustedOutput::IsFinal']/*"/>
|
|
<msdn-id>bb970324</msdn-id>
|
|
<unmanaged>HRESULT IMFTrustedOutput::IsFinal([Out] BOOL* pfIsFinal)</unmanaged>
|
|
<unmanaged-short>IMFTrustedOutput::IsFinal</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TrustedOutput.OutputTrustAuthorityCount">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTrustedOutput::GetOutputTrustAuthorityCount']/*"/>
|
|
<unmanaged>GetOutputTrustAuthorityCount</unmanaged>
|
|
<unmanaged-short>GetOutputTrustAuthorityCount</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTrustedOutput::GetOutputTrustAuthorityCount([Out] unsigned int* pcOutputTrustAuthorities)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TrustedOutput.IsFinal">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Queries whether this output is a policy sink, meaning it handles the rights and restrictions required by the input trust authority (ITA).</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>A trusted output is generally considered to be a policy sink if it does not pass the media content that it receives anywhere else; or, if it does pass the media content elsewhere, either it protects the content using some proprietary method such as encryption, or it sufficiently devalues the content so as not to require protection.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFTrustedOutput::IsFinal']/*"/>
|
|
<msdn-id>bb970324</msdn-id>
|
|
<unmanaged>IsFinal</unmanaged>
|
|
<unmanaged-short>IsFinal</unmanaged-short>
|
|
<unmanaged>HRESULT IMFTrustedOutput::IsFinal([Out] BOOL* pfIsFinal)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TrustedVideoPlugin">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Enables a plug-in component for the enhanced video renderer (EVR) to work with protected media.</p><p>To work in the protected media path (PMP), a custom EVR mixer or presenter must implement this interface. The EVR obtains a reference to this interface by calling <strong>QueryInterface</strong> on the plug-in component.</p><p>This interface is required only if the plug-in is a trusted component, designed to work in the PMP. It is not required for playing clear content in an unprotected process.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRTrustedVideoPlugin']/*"/>
|
|
<msdn-id>aa473784</msdn-id>
|
|
<unmanaged>IEVRTrustedVideoPlugin</unmanaged>
|
|
<unmanaged-short>IEVRTrustedVideoPlugin</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedVideoPlugin.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.TrustedVideoPlugin"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedVideoPlugin.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.TrustedVideoPlugin">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.TrustedVideoPlugin"/>. (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.MediaFoundation.TrustedVideoPlugin.IsInTrustedVideoMode(System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Queries whether the plug-in has any transient vulnerabilities at this time. </p>
|
|
</summary>
|
|
<param name="yesRef"><dd> <p>Receives a Boolean value. If <strong>TRUE</strong>, the plug-in has no transient vulnerabilities at the moment and can receive protected content. If <strong><see cref="F:SharpDX.Result.False"/></strong>, the plug-in has a transient vulnerability. If the method fails, the EVR treats the value as <strong><see cref="F:SharpDX.Result.False"/></strong> (untrusted).</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method provides a way for the plug-in to report temporary conditions that would cause the input trust authority (ITA) to distrust the plug-in. For example, if an EVR presenter is in windowed mode, it is vulnerable to GDI screen captures.</p><p>To disable screen capture in Direct3D, the plug-in must do the following:</p><ul> <li> <p>Create the Direct3D device in full-screen exlusive mode.</p> </li> <li> <p>Specify the D3DCREATE_DISABLE_PRINTSCREEN flag when you create the device. For more information, see <strong>IDirect3D9::CreateDevice</strong> in the DirectX documentation.</p> </li> </ul><p>In addition, the graphics adapter must support the Windows Vista Display Driver Model (WDDM) and the Direct3D extensions for Windows Vista (sometimes called D3D9Ex or D3D9L).</p><p>If these conditions are met, the presenter can return <strong>TRUE</strong> in the <em>pYes</em> parameter. Otherwise, it should return <strong><see cref="F:SharpDX.Result.False"/></strong>.</p><p>The EVR calls this method whenever the device changes. If the plug-in returns <strong><see cref="F:SharpDX.Result.False"/></strong>, the EVR treats this condition as if the plug-in had a new output connector of unknown type. The policy object can then allow or block playback, depending on the ITA's policy.</p><p>This method should be used only to report transient conditions. A plug-in that is never in a trusted state should not implement the <strong><see cref="T:SharpDX.MediaFoundation.TrustedVideoPlugin"/></strong> interface at all.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRTrustedVideoPlugin::IsInTrustedVideoMode']/*"/>
|
|
<msdn-id>aa473794</msdn-id>
|
|
<unmanaged>HRESULT IEVRTrustedVideoPlugin::IsInTrustedVideoMode([In] BOOL* pYes)</unmanaged>
|
|
<unmanaged-short>IEVRTrustedVideoPlugin::IsInTrustedVideoMode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedVideoPlugin.CanConstrict(System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Queries whether the plug-in can limit the effective video resolution. </p>
|
|
</summary>
|
|
<param name="yesRef"><dd> <p>Receives a Boolean value. If <strong>TRUE</strong>, the plug-in can limit the effective video resolution. Otherwise, the plug-in cannot limit the video resolution. If the method fails, the EVR treats the value as <strong><see cref="F:SharpDX.Result.False"/></strong> (not supported).</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Constriction is a protection mechanism that limits the effective resolution of the video frame to a specified maximum number of pixels.</p><p>Video constriction can be implemented by either the mixer or the presenter.</p><p>If the method returns <strong>TRUE</strong>, the EVR might call <strong><see cref="M:SharpDX.MediaFoundation.TrustedVideoPlugin.SetConstriction(System.Int32)"/></strong> at any time.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRTrustedVideoPlugin::CanConstrict']/*"/>
|
|
<msdn-id>aa473782</msdn-id>
|
|
<unmanaged>HRESULT IEVRTrustedVideoPlugin::CanConstrict([In] BOOL* pYes)</unmanaged>
|
|
<unmanaged-short>IEVRTrustedVideoPlugin::CanConstrict</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedVideoPlugin.SetConstriction(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Limits the effective video resolution. </p>
|
|
</summary>
|
|
<param name="dwKPix"><dd> <p>Maximum number of source pixels that may appear in the final video image, in thousands of pixels. If the value is zero, the video is disabled. If the value is MAXDWORD (0xFFFFFFFF), video constriction is removed and the video may be rendered at full resolution.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method limits the effective resolution of the video image. The actual resolution on the target device might be higher, due to stretching the image.</p><p>The EVR might call this method at any time if the <strong><see cref="M:SharpDX.MediaFoundation.TrustedVideoPlugin.CanConstrict(System.Boolean)"/></strong> method returns <strong>TRUE</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRTrustedVideoPlugin::SetConstriction']/*"/>
|
|
<msdn-id>aa473833</msdn-id>
|
|
<unmanaged>HRESULT IEVRTrustedVideoPlugin::SetConstriction([In] unsigned int dwKPix)</unmanaged>
|
|
<unmanaged-short>IEVRTrustedVideoPlugin::SetConstriction</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.TrustedVideoPlugin.DisableImageExport(System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Enables or disables the ability of the plug-in to export the video image. </p>
|
|
</summary>
|
|
<param name="bDisable"><dd> <p>Boolean value. Specify <strong>TRUE</strong> to disable image exporting, or <strong><see cref="F:SharpDX.Result.False"/></strong> to enable it.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>An EVR plug-in might expose a way for the application to get a copy of the video frames. For example, the standard EVR presenter implements <strong><see cref="M:SharpDX.MediaFoundation.VideoDisplayControl.GetCurrentImage(SharpDX.Win32.BitmapInfoHeader@,System.Byte[],System.Int32@,System.IntPtr)"/></strong>.</p><p>If the plug-in supports image exporting, this method enables or disables it. Before this method has been called for the first time, the EVR assumes that the mechanism is enabled.</p><p>If the plug-in does not support image exporting, this method should return <see cref="F:SharpDX.Result.Ok"/> and ignore the value of <em>bDisable</em>. If the method fails, the EVR treats it as a failure to enforce the policy, which will probably cause playback to stop.</p><p>While image exporting is disabled, any associated export method, such as <strong>GetCurrentImage</strong>, should return MF_E_LICENSE_INCORRECT_RIGHTS.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRTrustedVideoPlugin::DisableImageExport']/*"/>
|
|
<msdn-id>aa473830</msdn-id>
|
|
<unmanaged>HRESULT IEVRTrustedVideoPlugin::DisableImageExport([In] BOOL bDisable)</unmanaged>
|
|
<unmanaged-short>IEVRTrustedVideoPlugin::DisableImageExport</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.TrustedVideoPlugin.Constriction">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Limits the effective video resolution. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This method limits the effective resolution of the video image. The actual resolution on the target device might be higher, due to stretching the image.</p><p>The EVR might call this method at any time if the <strong><see cref="M:SharpDX.MediaFoundation.TrustedVideoPlugin.CanConstrict(System.Boolean)"/></strong> method returns <strong>TRUE</strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IEVRTrustedVideoPlugin::SetConstriction']/*"/>
|
|
<msdn-id>aa473833</msdn-id>
|
|
<unmanaged>SetConstriction</unmanaged>
|
|
<unmanaged-short>SetConstriction</unmanaged-short>
|
|
<unmanaged>HRESULT IEVRTrustedVideoPlugin::SetConstriction([In] unsigned int dwKPix)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoDeviceID">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Returns the device identifier supported by a video renderer component. This interface is implemented by mixers and presenters for the enhanced video renderer (EVR). If you replace either of these components, the mixer and presenter must report the same device identifier.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDeviceID']/*"/>
|
|
<msdn-id>ms703065</msdn-id>
|
|
<unmanaged>IMFVideoDeviceID</unmanaged>
|
|
<unmanaged-short>IMFVideoDeviceID</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDeviceID.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoDeviceID"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDeviceID.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoDeviceID">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoDeviceID"/>. (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.MediaFoundation.VideoDeviceID.GetDeviceID(System.Guid@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Returns the identifier of the video device supported by an EVR mixer or presenter.</p>
|
|
</summary>
|
|
<param name="deviceIDRef"><dd> <p>Receives the device identifier. Generally, the value is IID_IDirect3DDevice9.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The video renderer has been shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If a mixer or presenter uses Direct3D 9, it must return the value IID_IDirect3DDevice9 in <em>pDeviceID</em>. The EVR's default mixer and presenter both return this value. If you write a custom mixer or presenter, it can return some other value. However, the mixer and presenter must use matching device identifiers.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDeviceID::GetDeviceID']/*"/>
|
|
<msdn-id>ms704630</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDeviceID::GetDeviceID([Out] GUID* pDeviceID)</unmanaged>
|
|
<unmanaged-short>IMFVideoDeviceID::GetDeviceID</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoDeviceID.DeviceID">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Returns the identifier of the video device supported by an EVR mixer or presenter.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If a mixer or presenter uses Direct3D 9, it must return the value IID_IDirect3DDevice9 in <em>pDeviceID</em>. The EVR's default mixer and presenter both return this value. If you write a custom mixer or presenter, it can return some other value. However, the mixer and presenter must use matching device identifiers.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDeviceID::GetDeviceID']/*"/>
|
|
<msdn-id>ms704630</msdn-id>
|
|
<unmanaged>GetDeviceID</unmanaged>
|
|
<unmanaged-short>GetDeviceID</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoDeviceID::GetDeviceID([Out] GUID* pDeviceID)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoDisplayControl">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>IMFVideoDisplayControl</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoDisplayControl"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoDisplayControl">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoDisplayControl"/>. (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.MediaFoundation.VideoDisplayControl.GetNativeVideoSize(System.IntPtr,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the size and aspect ratio of the video, prior to any stretching by the video renderer. </p>
|
|
</summary>
|
|
<param name="szVideoRef"><dd> <p>Receives the size of the native video rectangle. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="szARVideoRef"><dd> <p>Receives the aspect ratio of the video. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_POINTER</strong></dt> </dl> </td><td> <p>At least one of the parameters must be non-<strong><c>null</c></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The video renderer has been shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>If no media types have been set on any video streams, the method succeeds but all parameters are set to zero.</p><p>You can set <em>pszVideo</em> or <em>pszARVideo</em> to <strong><c>null</c></strong>, but not both.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::GetNativeVideoSize']/*"/>
|
|
<msdn-id>ms694294</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetNativeVideoSize([InOut, Optional] SIZE* pszVideo,[InOut, Optional] SIZE* pszARVideo)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::GetNativeVideoSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.GetIdealVideoSize(System.IntPtr,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets the range of sizes that the enhanced video renderer (EVR) can display without significantly degrading performance or image quality. </p>
|
|
</summary>
|
|
<param name="szMinRef"><dd> <p>Receives the minimum ideal size. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="szMaxRef"><dd> <p>Receives the maximum ideal size. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_POINTER</strong></dt> </dl> </td><td> <p>At least one parameter must be non-<strong><c>null</c></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The video renderer has been shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>You can set <em>pszMin</em> or <em>pszMax</em> to <strong><c>null</c></strong>, but not both.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::GetIdealVideoSize']/*"/>
|
|
<msdn-id>ms703076</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetIdealVideoSize([InOut, Optional] SIZE* pszMin,[InOut, Optional] SIZE* pszMax)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::GetIdealVideoSize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.SetVideoPosition(System.Nullable{SharpDX.MediaFoundation.VideoNormalizedRect},System.Nullable{SharpDX.Rectangle})">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the source and destination rectangles for the video.</p>
|
|
</summary>
|
|
<param name="nrcSourceRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.VideoNormalizedRect"/></strong> structure that specifies the source rectangle. This parameter can be <strong><c>null</c></strong>. If this parameter is <strong><c>null</c></strong>, the source rectangle does not change.</p> </dd></param>
|
|
<param name="rcDestRef"><dd> <p>Specifies the destination rectangle. This parameter can be <strong><c>null</c></strong>. If this parameter is <strong><c>null</c></strong>, the destination rectangle does not change.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_POINTER</strong></dt> </dl> </td><td> <p>At least one parameter must be non-<strong><c>null</c></strong>.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The video renderer has been shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The source rectangle defines which portion of the video is displayed. It is specified in <em>normalized</em> coordinates. For more information, see <strong><see cref="T:SharpDX.MediaFoundation.VideoNormalizedRect"/></strong> structure. To display the entire video image, set the source rectangle to {0, 0, 1, 1}. The default source rectangle is {0, 0, 1, 1}.</p><p>The destination rectangle defines a rectangle within the clipping window where the video appears. It is specified in pixels, relative to the client area of the window. To fill the entire window, set the destination rectangle to {0, 0, <em>width</em>, <em>height</em>}, where <em>width</em> and <em>height</em> are dimensions of the window client area. The default destination rectangle is {0, 0, 0, 0}.</p><p>To update just one of these rectangles, set the other parameter to <strong><c>null</c></strong>. You can set <em>pnrcSource</em> or <em>prcDest</em> to <strong><c>null</c></strong>, but not both.</p><p>Before setting the destination rectangle (<em>prcDest</em>), you must set the video window by calling <strong><see cref="M:SharpDX.MediaFoundation.VideoDisplayControl.SetVideoWindow(System.IntPtr)"/></strong>. (For the Media Foundation version of the EVR, you can also provide the video window in the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoRendererActivate(System.IntPtr,SharpDX.MediaFoundation.Activate@)"/></strong> function.) If no video window was provided, <strong>SetVideoPosition</strong> returns E_POINTER.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::SetVideoPosition']/*"/>
|
|
<msdn-id>ms697352</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::SetVideoPosition([In, Optional] const MFVideoNormalizedRect* pnrcSource,[In, Optional] const RECT* prcDest)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::SetVideoPosition</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.GetVideoPosition(SharpDX.MediaFoundation.VideoNormalizedRect@,SharpDX.Rectangle@)">
|
|
<summary>
|
|
<p>Retrieves the source and destination rectangles for the video.</p> <see cref="T:SharpDX.Result"/> GetVideoPosition( <see cref="T:SharpDX.MediaFoundation.VideoNormalizedRect"/>* pnrcSource, LPRECT prcDest
|
|
);
|
|
<p></p>Parameters <p> pnrcSource </p> <p>[out] Pointer to an <see cref="T:SharpDX.MediaFoundation.VideoNormalizedRect"/> Structure that receives the source rectangle. This parameter can be <c>null</c>.</p> <p> prcDest </p> <p>[out] Receives the current destination rectangle. This parameter can be <c>null</c>.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>E_POINTER</p> </td> <td> <p>One or more required parameters are <c>null</c>.</p> </td> </tr><tr> <td> <p>MF_E_SHUTDOWN</p> </td> <td> <p>The video renderer has been shut down.</p> </td> </tr></table> <p>You can set pnrcSource or prcDest to <c>null</c>, but not both. </p> <p> Client: Requires Windows Vista.</p> <p> Header: Include evr.h.</p> <p> Library: Use strmiids.lib.</p> ReferenceIMFVideoDisplayControl InterfaceConceptsEnhanced Video RendererUsing the Video Display Controls
|
|
</summary>
|
|
<param name="nrcSourceRef">No documentation.</param>
|
|
<param name="rcDestRef">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='IMFVideoDisplayControl::GetVideoPosition']/*"/>
|
|
<msdn-id>ms704718</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetVideoPosition([Out] MFVideoNormalizedRect* pnrcSource,[Out] RECT* prcDest)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::GetVideoPosition</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.SetAspectRatioMode(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<param name="dwAspectRatioMode">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='IMFVideoDisplayControl::SetAspectRatioMode']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::SetAspectRatioMode([In] unsigned int dwAspectRatioMode)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::SetAspectRatioMode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.GetAspectRatioMode(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<param name="dwAspectRatioModeRef">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='IMFVideoDisplayControl::GetAspectRatioMode']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetAspectRatioMode([Out] unsigned int* pdwAspectRatioMode)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::GetAspectRatioMode</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.SetVideoWindow(System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the clipping window for the video.</p>
|
|
</summary>
|
|
<param name="hwndVideo"><dd> <p>Handle to the window where the enhanced video renderer (EVR) will draw the video.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p><em>hwndVideo</em> does not specify a valid window.</p> </td></tr> <tr><td> <dl> <dt><strong>S_FALSE</strong></dt> </dl> </td><td> <p>DWM thumbnails were not enabled/disabled.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The EVR will not display any video unless the application calls this method with a valid window handle.</p><p>For protected content, this method might disable Desktop Window Manager (DWM) thumbnail previews for the window. If thumbnail previews cannot be disabled, the method returns S_FALSE.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::SetVideoWindow']/*"/>
|
|
<msdn-id>ms697051</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::SetVideoWindow([In] HWND hwndVideo)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::SetVideoWindow</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.GetVideoWindow(System.IntPtr@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<param name="hwndVideoRef">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='IMFVideoDisplayControl::GetVideoWindow']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetVideoWindow([Out] HWND* phwndVideo)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::GetVideoWindow</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.RepaintVideo">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Repaints the current video frame. Call this method whenever the application receives a WM_PAINT message.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The EVR cannot repaint the frame at this time. This error can occur while the EVR is switching between full-screen and windowed mode. The caller can safely ignore this error.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The video renderer has been shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::RepaintVideo']/*"/>
|
|
<msdn-id>ms703113</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::RepaintVideo()</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::RepaintVideo</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.GetCurrentImage(SharpDX.Win32.BitmapInfoHeader@,System.Byte[],System.Int32@,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Gets a copy of the current image being displayed by the video renderer. </p>
|
|
</summary>
|
|
<param name="bihRef"><dd> <p>Pointer to a <strong><see cref="T:SharpDX.Win32.BitmapInfoHeader"/></strong> structure that receives a description of the bitmap. Set the <strong>biSize</strong> member of the structure to <code>sizeof(<see cref="T:SharpDX.Win32.BitmapInfoHeader"/>)</code> before calling the method.</p> </dd></param>
|
|
<param name="dibRef"><dd> <p>Receives a reference to a buffer that contains a packed Windows device-independent bitmap (DIB). The caller must free the memory for the bitmap by calling <strong>CoTaskMemFree</strong>.</p> </dd></param>
|
|
<param name="cbDibRef"><dd> <p>Receives the size of the buffer returned in <em>pDib</em>, in bytes.</p> </dd></param>
|
|
<param name="timeStampRef"><dd> <p>Receives the time stamp of the captured image.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_LICENSE_INCORRECT_RIGHTS</strong></dt> </dl> </td><td> <p>The content is protected and the license does not permit capturing the image.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The video renderer has been shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method can be called at any time. However, calling the method too frequently degrades the video playback performance.</p><p>This method retrieves a copy of the final composited image, which includes any substreams, alpha-blended bitmap, aspect ratio correction, background color, and so forth.</p><p>In windowed mode, the bitmap is the size of the destination rectangle specified in <strong><see cref="M:SharpDX.MediaFoundation.VideoDisplayControl.SetVideoPosition(System.Nullable{SharpDX.MediaFoundation.VideoNormalizedRect},System.Nullable{SharpDX.Rectangle})"/></strong>. In full-screen mode, the bitmap is the size of the display.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::GetCurrentImage']/*"/>
|
|
<msdn-id>ms695342</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetCurrentImage([InOut] BITMAPINFOHEADER* pBih,[Out, Buffer, Optional] unsigned char** pDib,[Out] unsigned int* pcbDib,[InOut, Optional] longlong* pTimeStamp)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::GetCurrentImage</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.SetBorderColor(SharpDX.Color4)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<param name="clr">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='IMFVideoDisplayControl::SetBorderColor']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::SetBorderColor([In] COLORREF Clr)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::SetBorderColor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.GetBorderColor(SharpDX.Color4@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<param name="clrRef">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='IMFVideoDisplayControl::GetBorderColor']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetBorderColor([Out] COLORREF* pClr)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::GetBorderColor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.SetRenderingPrefs(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<param name="dwRenderFlags">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='IMFVideoDisplayControl::SetRenderingPrefs']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::SetRenderingPrefs([In] unsigned int dwRenderFlags)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::SetRenderingPrefs</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.GetRenderingPrefs(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<param name="dwRenderFlagsRef">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='IMFVideoDisplayControl::GetRenderingPrefs']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetRenderingPrefs([Out] unsigned int* pdwRenderFlags)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::GetRenderingPrefs</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.SetFullscreen(System.Boolean)">
|
|
<summary>
|
|
<p>[This API is not supported and may be altered or unavailable in the future. ]</p><p><strong>Applies to: </strong>desktop apps only</p><p> Sets or unsets full-screen rendering mode.</p><p>To implement full-screen playback, an application should simply resize the video window to cover the entire area of the monitor. Also set the window to be a topmost window, so that the application receives all mouse-click messages. For more information about topmost windows, see the documentation for the <strong>SetWindowPos</strong> function.</p>
|
|
</summary>
|
|
<param name="fFullscreen">No documentation.</param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p> The video renderer has been shut down. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> The default EVR presenter implements full-screen mode using Direct3D exclusive mode. </p><p> If you use this method to switch to full-screen mode, set the application window to be a topmost window and resize the window to cover the entire monitor. This ensures that the application window receives all mouse-click messages. Also set the keyboard focus to the application window. When you switch out of full-screen mode, restore the window's original size and position. </p><p> By default, the cursor is still visible in full-screen mode. To hide the cursor, call <strong>ShowCursor</strong>. </p><p>The transition to and from full-screen mode occurs asynchronously. To get the current mode, call <strong><see cref="M:SharpDX.MediaFoundation.VideoDisplayControl.GetFullscreen(System.Boolean@)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::SetFullscreen']/*"/>
|
|
<msdn-id>ms701561</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::SetFullscreen([In] BOOL fFullscreen)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::SetFullscreen</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoDisplayControl.GetFullscreen(System.Boolean@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Queries whether the enhanced video renderer (EVR) is currently in full-screen mode. </p>
|
|
</summary>
|
|
<param name="fFullscreenRef"><dd> <p>Receives a Boolean value. If <strong>TRUE</strong>, the EVR is in full-screen mode. If <strong><see cref="F:SharpDX.Result.False"/></strong>, the EVR will display the video inside the application-provided clipping window.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The EVR is currently switching between full-screen and windowed mode.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::GetFullscreen']/*"/>
|
|
<msdn-id>ms704817</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetFullscreen([Out] BOOL* pfFullscreen)</unmanaged>
|
|
<unmanaged-short>IMFVideoDisplayControl::GetFullscreen</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoDisplayControl.AspectRatioMode">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::GetAspectRatioMode']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>GetAspectRatioMode</unmanaged>
|
|
<unmanaged-short>GetAspectRatioMode</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetAspectRatioMode([Out] unsigned int* pdwAspectRatioMode)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoDisplayControl.VideoWindow">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::GetVideoWindow']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>GetVideoWindow</unmanaged>
|
|
<unmanaged-short>GetVideoWindow</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetVideoWindow([Out] HWND* phwndVideo)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoDisplayControl.BorderColor">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::GetBorderColor']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>GetBorderColor</unmanaged>
|
|
<unmanaged-short>GetBorderColor</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetBorderColor([Out] COLORREF* pClr)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoDisplayControl.RenderingPrefs">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) displays video.</p><p>The EVR presenter implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier is <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li>The EVR media sink. </li> <li>The DirectShow EVR filter. </li> <li>The EVR presenter. </li> </ul><p>If you implement a custom presenter for the EVR, the presenter can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::GetRenderingPrefs']/*"/>
|
|
<msdn-id>ms704002</msdn-id>
|
|
<unmanaged>GetRenderingPrefs</unmanaged>
|
|
<unmanaged-short>GetRenderingPrefs</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetRenderingPrefs([Out] unsigned int* pdwRenderFlags)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoDisplayControl.Fullscreen">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Queries whether the enhanced video renderer (EVR) is currently in full-screen mode. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoDisplayControl::GetFullscreen']/*"/>
|
|
<msdn-id>ms704817</msdn-id>
|
|
<unmanaged>GetFullscreen</unmanaged>
|
|
<unmanaged-short>GetFullscreen</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoDisplayControl::GetFullscreen([Out] BOOL* pfFullscreen)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoMediaType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Represents a description of a video format.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>If the major type of a media type is MFMediaType_Video, you can query the media type object for the <strong><see cref="T:SharpDX.MediaFoundation.VideoMediaType"/></strong> interface.</p><p>Applications should avoid using this interface except when a method or function requires an <strong><see cref="T:SharpDX.MediaFoundation.VideoMediaType"/></strong> reference as a parameter. You can get all of the format information from a video media type through the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface, which <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> inherits.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMediaType']/*"/>
|
|
<msdn-id>aa473814</msdn-id>
|
|
<unmanaged>IMFVideoMediaType</unmanaged>
|
|
<unmanaged-short>IMFVideoMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMediaType.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoMediaType"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMediaType.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoMediaType">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoMediaType"/>. (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.MediaFoundation.VideoMediaType.GetVideoFormat">
|
|
<summary>
|
|
<p>[<strong>GetVideoFormat</strong> is no longer available for use as of Windows?7. Instead, use the media type attributes to get the properties of the video format.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Returns a reference to an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure that describes the video format.</p>
|
|
</summary>
|
|
<returns><p> This method returns a reference to an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure. </p></returns>
|
|
<remarks>
|
|
<p> If you need to convert the media type into an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMFVideoFormatFromMFMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.Videoformat@,System.Int32@)"/></strong>.</p><p>There are no guarantees about how long the returned reference is valid.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMediaType::GetVideoFormat']/*"/>
|
|
<msdn-id>aa473785</msdn-id>
|
|
<unmanaged>const MFVIDEOFORMAT* IMFVideoMediaType::GetVideoFormat()</unmanaged>
|
|
<unmanaged-short>IMFVideoMediaType::GetVideoFormat</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMediaType.GetVideoRepresentation(System.Guid,System.IntPtr@,System.Int32)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="guidRepresentation">No documentation.</param>
|
|
<param name="vRepresentationOut">No documentation.</param>
|
|
<param name="lStride">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='IMFVideoMediaType::GetVideoRepresentation']/*"/>
|
|
<unmanaged>HRESULT IMFVideoMediaType::GetVideoRepresentation([In] GUID guidRepresentation,[Out] void** ppvRepresentation,[In] int lStride)</unmanaged>
|
|
<unmanaged-short>IMFVideoMediaType::GetVideoRepresentation</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoMediaType.VideoFormat">
|
|
<summary>
|
|
<p>[<strong>GetVideoFormat</strong> is no longer available for use as of Windows?7. Instead, use the media type attributes to get the properties of the video format.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Returns a reference to an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure that describes the video format.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> If you need to convert the media type into an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateMFVideoFormatFromMFMediaType(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.Videoformat@,System.Int32@)"/></strong>.</p><p>There are no guarantees about how long the returned reference is valid.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMediaType::GetVideoFormat']/*"/>
|
|
<msdn-id>aa473785</msdn-id>
|
|
<unmanaged>GetVideoFormat</unmanaged>
|
|
<unmanaged-short>GetVideoFormat</unmanaged-short>
|
|
<unmanaged>const MFVIDEOFORMAT* IMFVideoMediaType::GetVideoFormat()</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoMixerControl">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls how the Enhanced Video Renderer (EVR) mixes video substreams. Applications can use this interface to control video mixing during playback.</p><p>The EVR mixer implements this interface. To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong>. The service identifier <see cref="T:System.Guid"/> is MR_VIDEO_MIXER_SERVICE. Call <strong>GetService</strong> on any of the following objects:</p><ul> <li> The Media Session, if the topology contains an instance of the EVR. </li> <li> The EVR media sink. </li> <li> The DirectShow EVR filter. </li> <li> The EVR mixer. </li> </ul><p>If you implement a custom mixer for the EVR, the mixer can optionally expose this interface as a service.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMixerControl']/*"/>
|
|
<msdn-id>ms700190</msdn-id>
|
|
<unmanaged>IMFVideoMixerControl</unmanaged>
|
|
<unmanaged-short>IMFVideoMixerControl</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMixerControl.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoMixerControl"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMixerControl.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoMixerControl">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoMixerControl"/>. (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.MediaFoundation.VideoMixerControl.SetStreamZOrder(System.Int32,System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets the z-order of a video stream.</p>
|
|
</summary>
|
|
<param name="dwStreamID"><dd> <p>Identifier of the stream. For the EVR media sink, the stream identifier is defined when the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong> method is called. For the DirectShow EVR filter, the stream identifier corresponds to the pin index. The reference stream is always stream 0.</p> </dd></param>
|
|
<param name="dwZ"><dd> <p>Z-order value. The z-order of the reference stream must be zero. The maximum z-order value is the number of streams minus one.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>The value of <em>dwZ</em> is larger than the maximum z-order value.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>Invalid z-order for this stream. For the reference stream, <em>dwZ</em> must be zero. For all other streams, <em>dwZ</em> must be greater than zero.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p>Invalid stream identifier.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The EVR draws the video streams in the order of their z-order values, starting with zero. The reference stream must be first in the z-order, and the remaining streams can be in any order.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMixerControl::SetStreamZOrder']/*"/>
|
|
<msdn-id>ms697453</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoMixerControl::SetStreamZOrder([In] unsigned int dwStreamID,[In] unsigned int dwZ)</unmanaged>
|
|
<unmanaged-short>IMFVideoMixerControl::SetStreamZOrder</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMixerControl.GetStreamZOrder(System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the z-order of a video stream.</p>
|
|
</summary>
|
|
<param name="dwStreamID"><dd> <p>Identifier of the stream. For the EVR media sink, the stream identifier is defined when the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong> method is called. For the DirectShow EVR filter, the stream identifier corresponds to the pin index. The reference stream is always stream 0.</p> </dd></param>
|
|
<param name="dwZRef"><dd> <p>Receives the z-order value.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p>Invalid stream identifier.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMixerControl::GetStreamZOrder']/*"/>
|
|
<msdn-id>ms701614</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoMixerControl::GetStreamZOrder([In] unsigned int dwStreamID,[Out] unsigned int* pdwZ)</unmanaged>
|
|
<unmanaged-short>IMFVideoMixerControl::GetStreamZOrder</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMixerControl.SetStreamOutputRect(System.Int32,SharpDX.MediaFoundation.VideoNormalizedRect)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Sets the position of a video stream within the composition rectangle. </p>
|
|
</summary>
|
|
<param name="dwStreamID"><dd> <p>Identifier of the stream. For the EVR media sink, the stream identifier is defined when the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong> method is called. For the DirectShow EVR filter, the stream identifier corresponds to the pin index. The reference stream is always stream 0.</p> </dd></param>
|
|
<param name="nrcOutputRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.VideoNormalizedRect"/></strong> structure that defines the bounding rectangle for the video stream.</p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p> The coordinates of the bounding rectangle given in <em>pnrcOutput</em> are not valid. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p> Invalid stream identifier. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p> The mixer draws each video stream inside a bounding rectangle that is specified relative to the final video image. This bounding rectangle is given in <em>normalized</em> coordinates. For more information, see <strong><see cref="T:SharpDX.MediaFoundation.VideoNormalizedRect"/></strong> structure. </p><p> The coordinates of the bounding rectangle must fall within the range [0.0, 1.0]. Also, the X and Y coordinates of the upper-left corner cannot exceed the X and Y coordinates of the lower-right corner. In other words, the bounding rectangle must fit entirely within the composition rectangle and cannot be flipped vertically or horizontally. </p><p>The following diagram shows how the EVR mixes substreams.</p><p>The output rectangle for the stream is specified by calling <strong>SetStreamOutputRect</strong>. The source rectangle is specified by calling <strong><see cref="M:SharpDX.MediaFoundation.VideoDisplayControl.SetVideoPosition(System.Nullable{SharpDX.MediaFoundation.VideoNormalizedRect},System.Nullable{SharpDX.Rectangle})"/></strong>. The mixer applies the output rectangle first, when it mixes the streams into a single bounding rectangle. This bounding rectangle is called <em>composition space</em>. Then the presenter applies the source rectangle to the composited image.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMixerControl::SetStreamOutputRect']/*"/>
|
|
<msdn-id>ms698959</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoMixerControl::SetStreamOutputRect([In] unsigned int dwStreamID,[In] const MFVideoNormalizedRect* pnrcOutput)</unmanaged>
|
|
<unmanaged-short>IMFVideoMixerControl::SetStreamOutputRect</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMixerControl.GetStreamOutputRect(System.Int32,SharpDX.MediaFoundation.VideoNormalizedRect@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the position of a video stream within the composition rectangle.</p>
|
|
</summary>
|
|
<param name="dwStreamID"><dd> <p>The identifier of the stream. For the EVR media sink, the stream identifier is defined when the <strong><see cref="M:SharpDX.MediaFoundation.MediaSink.AddStreamSink(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.StreamSink@)"/></strong> method is called. For the DirectShow EVR filter, the stream identifier corresponds to the pin index. The reference stream is always stream 0.</p> </dd></param>
|
|
<param name="nrcOutputRef"><dd> <p>Pointer to an <strong><see cref="T:SharpDX.MediaFoundation.VideoNormalizedRect"/></strong> structure that receives the bounding rectangle, in normalized coordinates.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDSTREAMNUMBER</strong></dt> </dl> </td><td> <p>Invalid stream identifier.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMixerControl::GetStreamOutputRect']/*"/>
|
|
<msdn-id>ms698911</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoMixerControl::GetStreamOutputRect([In] unsigned int dwStreamID,[Out] MFVideoNormalizedRect* pnrcOutput)</unmanaged>
|
|
<unmanaged-short>IMFVideoMixerControl::GetStreamOutputRect</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoMixerControl2">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Controls preferences for video deinterlacing.</p><p> The default video mixer for the Enhanced Video Renderer (EVR) implements this interface.</p><p>To get a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> on any of the following objects, using the <strong>MR_VIDEO_MIXER_SERVICE</strong> service identifier:</p><ul> <li>The Media Session, if the topology contains an instance of the EVR.</li> <li>The EVR media sink.</li> <li>The DirectShow EVR filter.</li> <li>The EVR mixer.</li> </ul>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMixerControl2']/*"/>
|
|
<msdn-id>dd374894</msdn-id>
|
|
<unmanaged>IMFVideoMixerControl2</unmanaged>
|
|
<unmanaged-short>IMFVideoMixerControl2</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMixerControl2.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoMixerControl2"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMixerControl2.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoMixerControl2">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoMixerControl2"/>. (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.MediaFoundation.VideoMixerControl2.SetMixingPrefs(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets the preferences for video deinterlacing.</p>
|
|
</summary>
|
|
<param name="dwMixFlags"><dd> <p>Bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.VideoMixPrefs"/></strong> enumeration. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMixerControl2::SetMixingPrefs']/*"/>
|
|
<msdn-id>dd374898</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoMixerControl2::SetMixingPrefs([In] unsigned int dwMixFlags)</unmanaged>
|
|
<unmanaged-short>IMFVideoMixerControl2::SetMixingPrefs</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoMixerControl2.GetMixingPrefs(System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the current preferences for video deinterlacing.</p>
|
|
</summary>
|
|
<param name="dwMixFlagsRef"><dd> <p>Receives a bitwise <strong>OR</strong> of zero or more flags from the <strong><see cref="T:SharpDX.MediaFoundation.VideoMixPrefs"/></strong> enumeration.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMixerControl2::GetMixingPrefs']/*"/>
|
|
<msdn-id>dd374896</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoMixerControl2::GetMixingPrefs([Out] unsigned int* pdwMixFlags)</unmanaged>
|
|
<unmanaged-short>IMFVideoMixerControl2::GetMixingPrefs</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoMixerControl2.MixingPrefs">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Gets the current preferences for video deinterlacing.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoMixerControl2::GetMixingPrefs']/*"/>
|
|
<msdn-id>dd374896</msdn-id>
|
|
<unmanaged>GetMixingPrefs</unmanaged>
|
|
<unmanaged-short>GetMixingPrefs</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoMixerControl2::GetMixingPrefs([Out] unsigned int* pdwMixFlags)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoPositionMapper">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Maps a position on an input video stream to the corresponding position on an output video stream.</p><p>To obtain a reference to this interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> on the renderer with the service <see cref="T:System.Guid"/> MR_VIDEO_RENDER_SERVICE.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoPositionMapper']/*"/>
|
|
<msdn-id>ms695386</msdn-id>
|
|
<unmanaged>IMFVideoPositionMapper</unmanaged>
|
|
<unmanaged-short>IMFVideoPositionMapper</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoPositionMapper.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoPositionMapper"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoPositionMapper.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoPositionMapper">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoPositionMapper"/>. (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.MediaFoundation.VideoPositionMapper.MapOutputCoordinateToInputStream(System.Single,System.Single,System.Int32,System.Int32,System.Single@,System.Single@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Maps output image coordinates to input image coordinates. This method provides the reverse transformation for components that map coordinates on the input image to different coordinates on the output image. </p>
|
|
</summary>
|
|
<param name="xOut"><dd> <p> X-coordinate of the output image, normalized to the range [0...1]. </p> </dd></param>
|
|
<param name="yOut"><dd> <p> Y-coordinate of the output image, normalized to the range [0...1]. </p> </dd></param>
|
|
<param name="dwOutputStreamIndex"><dd> <p> Output stream index for the coordinate mapping. </p> </dd></param>
|
|
<param name="dwInputStreamIndex"><dd> <p> Input stream index for the coordinate mapping. </p> </dd></param>
|
|
<param name="xInRef"><dd> <p> Receives the mapped x-coordinate of the input image, normalized to the range [0...1]. </p> </dd></param>
|
|
<param name="yInRef"><dd> <p> Receives the mapped y-coordinate of the input image, normalized to the range [0...1]. </p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p> The video renderer has been shut down. </p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>In the following diagram, R(dest) is the destination rectangle for the video. You can obtain this rectangle by calling <strong><see cref="M:SharpDX.MediaFoundation.VideoDisplayControl.GetVideoPosition(SharpDX.MediaFoundation.VideoNormalizedRect@,SharpDX.Rectangle@)"/></strong>. The rectangle R1 is a substream within the video. The point P has pixel coordinates (x,y) relative to R(dest).</p><p></p><p>The position of P relative to R(dest) in <em>normalized</em> coordinates is calculated as follows:</p><code>float xn = float(x + 0.5) / widthDest;
|
|
float xy = float(y + 0.5) / heightDest;
|
|
</code><p>where <em>widthDest</em> and <em>heightDest</em> are the width and height of R(dest) in pixels.</p><p>To calculate the position of P relative to R1, call <strong>MapOutputCoordinateToInputStream</strong> as follows:</p><code>float x1 = 0, y1 = 0;
|
|
hr = pMap->MapOutputCoordinateToInputStream(xn, yn, 0, dwInputStreamIndex, &x1, &y1);</code><p>The values returned in <em>x1</em> and <em>y1</em> are normalized to the range [0...1]. To convert back to pixel coordinates, scale these values by the size of R1:</p><code>int scaledx = int(floor(x1 * widthR1));
|
|
int scaledy = int(floor(xy * heightR1));</code><p>Note that <em>x1</em> and <em>y1</em> might fall outside the range [0...1] if P lies outside of R1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoPositionMapper::MapOutputCoordinateToInputStream']/*"/>
|
|
<msdn-id>ms703892</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoPositionMapper::MapOutputCoordinateToInputStream([In] float xOut,[In] float yOut,[In] unsigned int dwOutputStreamIndex,[In] unsigned int dwInputStreamIndex,[Out] float* pxIn,[Out] float* pyIn)</unmanaged>
|
|
<unmanaged-short>IMFVideoPositionMapper::MapOutputCoordinateToInputStream</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoPresenter">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Represents a video presenter. A <em>video presenter</em> is an object that receives video frames, typically from a video mixer, and presents them in some way, typically by rendering them to the display. The enhanced video renderer (EVR) provides a default video presenter, and applications can implement custom presenters.</p><p>The video presenter receives video frames as soon as they are available from upstream. The video presenter is responsible for presenting frames at the correct time and for synchronizing with the presentation clock.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoPresenter']/*"/>
|
|
<msdn-id>ms700214</msdn-id>
|
|
<unmanaged>IMFVideoPresenter</unmanaged>
|
|
<unmanaged-short>IMFVideoPresenter</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoPresenter.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoPresenter"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoPresenter.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoPresenter">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoPresenter"/>. (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.MediaFoundation.VideoPresenter.ProcessMessage(SharpDX.MediaFoundation.VpMessageType,System.IntPtr)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sends a message to the video presenter. Messages are used to signal the presenter that it must perform some action, or that some event has occurred.</p>
|
|
</summary>
|
|
<param name="eMessage"><dd> <p>Specifies the message as a member of the <strong><see cref="T:SharpDX.MediaFoundation.VpMessageType"/></strong> enumeration.</p> </dd></param>
|
|
<param name="ulParam"><dd> <p>Message parameter. The meaning of this parameter depends on the message type.</p> </dd></param>
|
|
<returns><p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The video renderer has been shut down.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoPresenter::ProcessMessage']/*"/>
|
|
<msdn-id>bb970573</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoPresenter::ProcessMessage([In] MFVP_MESSAGE_TYPE eMessage,[In] ULONG_PTR ulParam)</unmanaged>
|
|
<unmanaged-short>IMFVideoPresenter::ProcessMessage</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoPresenter.GetCurrentMediaType(SharpDX.MediaFoundation.VideoMediaType@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Represents a video presenter. A <em>video presenter</em> is an object that receives video frames, typically from a video mixer, and presents them in some way, typically by rendering them to the display. The enhanced video renderer (EVR) provides a default video presenter, and applications can implement custom presenters.</p><p>The video presenter receives video frames as soon as they are available from upstream. The video presenter is responsible for presenting frames at the correct time and for synchronizing with the presentation clock.</p>
|
|
</summary>
|
|
<param name="mediaTypeOut">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='IMFVideoPresenter::GetCurrentMediaType']/*"/>
|
|
<msdn-id>ms700214</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoPresenter::GetCurrentMediaType([Out] IMFVideoMediaType** ppMediaType)</unmanaged>
|
|
<unmanaged-short>IMFVideoPresenter::GetCurrentMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoPresenter.CurrentMediaType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Represents a video presenter. A <em>video presenter</em> is an object that receives video frames, typically from a video mixer, and presents them in some way, typically by rendering them to the display. The enhanced video renderer (EVR) provides a default video presenter, and applications can implement custom presenters.</p><p>The video presenter receives video frames as soon as they are available from upstream. The video presenter is responsible for presenting frames at the correct time and for synchronizing with the presentation clock.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoPresenter::GetCurrentMediaType']/*"/>
|
|
<msdn-id>ms700214</msdn-id>
|
|
<unmanaged>GetCurrentMediaType</unmanaged>
|
|
<unmanaged-short>GetCurrentMediaType</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoPresenter::GetCurrentMediaType([Out] IMFVideoMediaType** ppMediaType)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoProcessorControl">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Specifies whether to rotate the video to the correct orientation.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The original orientation of the video is specified by the <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.VideoRotation"/> attribute of the input media type.</p><p> If <em>eRotation</em> is <strong><see cref="F:SharpDX.MediaFoundation.VideoProcessorRotation.RotationNone"/></strong>, the video processor does not correct the orientation of the output video. If the original video is rotated, and <em>eRotation</em> is <strong><see cref="F:SharpDX.MediaFoundation.VideoProcessorRotation.RotationNormal"/></strong>, the video processor corrects the orientation, so that the ouput video is not rotated. The video processor letterboxes the output as needed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl']/*"/>
|
|
<msdn-id>hh448074</msdn-id>
|
|
<unmanaged>IMFVideoProcessorControl</unmanaged>
|
|
<unmanaged-short>IMFVideoProcessorControl</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoProcessorControl.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoProcessorControl"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoProcessorControl.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoProcessorControl">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoProcessorControl"/>. (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.MediaFoundation.VideoProcessorControl.SetBorderColor(System.Nullable{SharpDX.MediaFoundation.Argb})">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Sets the border color.</p>
|
|
</summary>
|
|
<param name="borderColorRef"><dd> <p>A reference to an <strong><see cref="T:SharpDX.MediaFoundation.Argb"/></strong> structure that specifies the border color as an ARGB (alpha, red, green, blue) value.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetBorderColor']/*"/>
|
|
<msdn-id>hh448070</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetBorderColor([In, Optional] MFARGB* pBorderColor)</unmanaged>
|
|
<unmanaged-short>IMFVideoProcessorControl::SetBorderColor</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoProcessorControl.SetSourceRectangle(System.Nullable{SharpDX.Rectangle})">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Sets the source rectangle. The source rectangle is the portion of the input frame that is blitted to the destination surface.</p>
|
|
</summary>
|
|
<param name="srcRectRef"><dd> <p>A reference to a <strong><see cref="T:SharpDX.Rectangle"/></strong> structure that specifies the source rectangle.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetSourceRectangle']/*"/>
|
|
<msdn-id>hh448075</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetSourceRectangle([In, Optional] RECT* pSrcRect)</unmanaged>
|
|
<unmanaged-short>IMFVideoProcessorControl::SetSourceRectangle</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoProcessorControl.SetDestinationRectangle(System.Nullable{SharpDX.Rectangle})">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Sets the destination rectangle. The destination rectangle is the portion of the output surface where the source rectangle is blitted.</p>
|
|
</summary>
|
|
<param name="dstRectRef"><dd> <p>A reference to a <strong><see cref="T:SharpDX.Rectangle"/></strong> structure that specifies the destination rectangle.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetDestinationRectangle']/*"/>
|
|
<msdn-id>hh448072</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetDestinationRectangle([In, Optional] RECT* pDstRect)</unmanaged>
|
|
<unmanaged-short>IMFVideoProcessorControl::SetDestinationRectangle</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoProcessorControl.SetMirror(SharpDX.MediaFoundation.VideoProcessorMirror)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Specifies whether to flip the video image.</p>
|
|
</summary>
|
|
<param name="eMirror"><dd> <p>An <strong><see cref="T:SharpDX.MediaFoundation.VideoProcessorMirror"/></strong> value that specifies whether to flip the video image, either horizontally or vertically.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetMirror']/*"/>
|
|
<msdn-id>hh448073</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetMirror([In] MF_VIDEO_PROCESSOR_MIRROR eMirror)</unmanaged>
|
|
<unmanaged-short>IMFVideoProcessorControl::SetMirror</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoProcessorControl.SetRotation(SharpDX.MediaFoundation.VideoProcessorRotation)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Specifies whether to rotate the video to the correct orientation.</p>
|
|
</summary>
|
|
<param name="eRotation"><dd> <p>A <strong><see cref="T:SharpDX.MediaFoundation.VideoProcessorRotation"/></strong> value that specifies whether to rotate the image.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>The original orientation of the video is specified by the <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.VideoRotation"/> attribute of the input media type.</p><p> If <em>eRotation</em> is <strong><see cref="F:SharpDX.MediaFoundation.VideoProcessorRotation.RotationNone"/></strong>, the video processor does not correct the orientation of the output video. If the original video is rotated, and <em>eRotation</em> is <strong><see cref="F:SharpDX.MediaFoundation.VideoProcessorRotation.RotationNormal"/></strong>, the video processor corrects the orientation, so that the ouput video is not rotated. The video processor letterboxes the output as needed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetRotation']/*"/>
|
|
<msdn-id>hh448074</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetRotation([In] MF_VIDEO_PROCESSOR_ROTATION eRotation)</unmanaged>
|
|
<unmanaged-short>IMFVideoProcessorControl::SetRotation</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoProcessorControl.SetConstrictionSize(System.Nullable{SharpDX.DrawingSize})">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Specifies the amount of downsampling to perform on the output.</p>
|
|
</summary>
|
|
<param name="constrictionSizeRef"><dd> <p>The sampling size. To disable constriction, set this parameter to <strong><c>null</c></strong>.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetConstrictionSize']/*"/>
|
|
<msdn-id>hh448071</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetConstrictionSize([In, Optional] SIZE* pConstrictionSize)</unmanaged>
|
|
<unmanaged-short>IMFVideoProcessorControl::SetConstrictionSize</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoProcessorControl.BorderColor">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Sets the border color.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetBorderColor']/*"/>
|
|
<msdn-id>hh448070</msdn-id>
|
|
<unmanaged>SetBorderColor</unmanaged>
|
|
<unmanaged-short>SetBorderColor</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetBorderColor([In, Optional] MFARGB* pBorderColor)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoProcessorControl.SourceRectangle">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Sets the source rectangle. The source rectangle is the portion of the input frame that is blitted to the destination surface.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetSourceRectangle']/*"/>
|
|
<msdn-id>hh448075</msdn-id>
|
|
<unmanaged>SetSourceRectangle</unmanaged>
|
|
<unmanaged-short>SetSourceRectangle</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetSourceRectangle([In, Optional] RECT* pSrcRect)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoProcessorControl.DestinationRectangle">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Sets the destination rectangle. The destination rectangle is the portion of the output surface where the source rectangle is blitted.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetDestinationRectangle']/*"/>
|
|
<msdn-id>hh448072</msdn-id>
|
|
<unmanaged>SetDestinationRectangle</unmanaged>
|
|
<unmanaged-short>SetDestinationRectangle</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetDestinationRectangle([In, Optional] RECT* pDstRect)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoProcessorControl.Mirror">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Specifies whether to flip the video image.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetMirror']/*"/>
|
|
<msdn-id>hh448073</msdn-id>
|
|
<unmanaged>SetMirror</unmanaged>
|
|
<unmanaged-short>SetMirror</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetMirror([In] MF_VIDEO_PROCESSOR_MIRROR eMirror)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoProcessorControl.Rotation">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Specifies whether to rotate the video to the correct orientation.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The original orientation of the video is specified by the <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.VideoRotation"/> attribute of the input media type.</p><p> If <em>eRotation</em> is <strong><see cref="F:SharpDX.MediaFoundation.VideoProcessorRotation.RotationNone"/></strong>, the video processor does not correct the orientation of the output video. If the original video is rotated, and <em>eRotation</em> is <strong><see cref="F:SharpDX.MediaFoundation.VideoProcessorRotation.RotationNormal"/></strong>, the video processor corrects the orientation, so that the ouput video is not rotated. The video processor letterboxes the output as needed.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetRotation']/*"/>
|
|
<msdn-id>hh448074</msdn-id>
|
|
<unmanaged>SetRotation</unmanaged>
|
|
<unmanaged-short>SetRotation</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetRotation([In] MF_VIDEO_PROCESSOR_ROTATION eRotation)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoProcessorControl.ConstrictionSize">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Specifies the amount of downsampling to perform on the output.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoProcessorControl::SetConstrictionSize']/*"/>
|
|
<msdn-id>hh448071</msdn-id>
|
|
<unmanaged>SetConstrictionSize</unmanaged>
|
|
<unmanaged-short>SetConstrictionSize</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoProcessorControl::SetConstrictionSize([In, Optional] SIZE* pConstrictionSize)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoRenderer">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Sets a new mixer or presenter for the Enhanced Video Renderer (EVR).</p><p>Both the EVR media sink and the DirectShow EVR filter implement this interface. To get a reference to the interface, call <strong>QueryInterface</strong> on the media sink or the filter. Do not use <strong><see cref="T:SharpDX.MediaFoundation.ServiceProvider"/></strong> to get a reference to this interface.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The EVR activation object returned by the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoRendererActivate(System.IntPtr,SharpDX.MediaFoundation.Activate@)"/></strong> function does not expose this interface. Instead, the activation object supports attributes that specify a custom mixer or presenter. For more information, see Enhanced Video Renderer Attributes.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoRenderer']/*"/>
|
|
<msdn-id>ms698954</msdn-id>
|
|
<unmanaged>IMFVideoRenderer</unmanaged>
|
|
<unmanaged-short>IMFVideoRenderer</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoRenderer.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoRenderer"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoRenderer.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoRenderer">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoRenderer"/>. (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.MediaFoundation.VideoRenderer.InitializeRenderer(SharpDX.MediaFoundation.Transform,SharpDX.MediaFoundation.VideoPresenter)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Sets a new mixer or presenter for the enhanced video renderer (EVR).</p>
|
|
</summary>
|
|
<param name="videoMixerRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.Transform"/></strong> interface of the mixer to use. This parameter can be <strong><c>null</c></strong>. If this parameter is <strong><c>null</c></strong>, the EVR uses its default mixer.</p> </dd></param>
|
|
<param name="videoPresenterRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.VideoPresenter"/></strong> interface of the presenter to use. This parameter can be <strong><c>null</c></strong>. If this parameter is <strong><c>null</c></strong>, the EVR uses its default presenter.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>Either the mixer or the presenter is invalid.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDREQUEST</strong></dt> </dl> </td><td> <p>The mixer and presenter cannot be replaced in the current state. (EVR media sink.)</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_SHUTDOWN</strong></dt> </dl> </td><td> <p>The video renderer has been shut down.</p> </td></tr> <tr><td> <dl> <dt><strong>VFW_E_WRONG_STATE</strong></dt> </dl> </td><td> <p>One or more input pins are connected. (DirectShow EVR filter.)</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method directly after creating the EVR, before you do any of the following:</p><ul> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> on the EVR.</p> </li> <li> <p>Call <strong><see cref="M:SharpDX.MediaFoundation.FilterConfig.SetNumberOfStreams(System.Int32)"/></strong> on the EVR.</p> </li> <li> <p>Connect any pins on the EVR filter, or set any media types on EVR media sink.</p> </li> </ul><p>The EVR filter returns VFW_E_WRONG_STATE if any of the filter's pins are connected. The EVR media sink returns MF_E_INVALIDREQUEST if a media type is set on any of the streams, or the presentation clock is running or paused.</p><p>The device identifiers for the mixer and the presenter must match. The <strong><see cref="M:SharpDX.MediaFoundation.VideoDeviceID.GetDeviceID(System.Guid@)"/></strong> method returns the device identifier. If they do not match, the method returns E_INVALIDARG.</p><p>If the video renderer is in the protected media path (PMP), the mixer and presenter objects must be certified safe components and pass any trust authority verification that is being enforced. Otherwise, this method will fail.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoRenderer::InitializeRenderer']/*"/>
|
|
<msdn-id>ms704667</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoRenderer::InitializeRenderer([In, Optional] IMFTransform* pVideoMixer,[In, Optional] IMFVideoPresenter* pVideoPresenter)</unmanaged>
|
|
<unmanaged-short>IMFVideoRenderer::InitializeRenderer</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoSampleAllocator">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Allocates video samples for a video media sink.</p><p>The stream sinks on the enhanced video renderer (EVR) expose this interface as a service. To obtain a reference to the interface, call <strong><see cref="M:SharpDX.MediaFoundation.ServiceProvider.GetService(System.Guid,System.Guid,System.IntPtr@)"/></strong> using the service identifier MR_VIDEO_ACCELERATION_SERVICE. Custom media sinks can also implement this interface. The Media Session uses this interface to allocate samples for the EVR, unless the upstream decoder supports DirectX Video Acceleration (DXVA).</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocator']/*"/>
|
|
<msdn-id>aa473823</msdn-id>
|
|
<unmanaged>IMFVideoSampleAllocator</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocator</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocator.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoSampleAllocator"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocator.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoSampleAllocator">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoSampleAllocator"/>. (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.MediaFoundation.VideoSampleAllocator.SetDirectXManager(SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Specifies the Direct3D device manager for the video media sink to use.</p>
|
|
</summary>
|
|
<param name="managerRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the Direct3D device manager. The media sink queries this reference for the <strong>IDirect3DDeviceManager9</strong> interface.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>The media sink uses the Direct3D device manager to obtain a reference to the Direct3D device, which it uses to allocate Direct3D surfaces. The device manager enables multiple objects in the pipeline (such as a video renderer and a video decoder) to share the same Direct3D device.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocator::SetDirectXManager']/*"/>
|
|
<msdn-id>aa473819</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoSampleAllocator::SetDirectXManager([In] IUnknown* pManager)</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocator::SetDirectXManager</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocator.UninitializeSampleAllocator">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Releases all of the video samples that have been allocated.</p>
|
|
</summary>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocator::UninitializeSampleAllocator']/*"/>
|
|
<msdn-id>aa473807</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoSampleAllocator::UninitializeSampleAllocator()</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocator::UninitializeSampleAllocator</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocator.InitializeSampleAllocator(System.Int32,SharpDX.MediaFoundation.MediaType)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Specifies the number of samples to allocate and the media type for the samples. </p>
|
|
</summary>
|
|
<param name="cRequestedFrames"><dd> <p> Number of samples to allocate. </p> </dd></param>
|
|
<param name="mediaTypeRef"><dd> <p> Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of a media type that describes the video format. </p> </dd></param>
|
|
<returns><p> The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table. </p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p> The method succeeded. </p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_INVALIDMEDIATYPE</strong></dt> </dl> </td><td> <p>Invalid media type.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocator::InitializeSampleAllocator']/*"/>
|
|
<msdn-id>bb970496</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoSampleAllocator::InitializeSampleAllocator([In] unsigned int cRequestedFrames,[In] IMFMediaType* pMediaType)</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocator::InitializeSampleAllocator</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocator.AllocateSample(SharpDX.MediaFoundation.Sample@)">
|
|
<summary>
|
|
<p>Retrieves a video sample.</p> <see cref="T:SharpDX.Result"/> AllocateSample( <see cref="T:SharpDX.MediaFoundation.Sample"/>** ppSample
|
|
);<p></p>Parameters <p> ppSample </p> <p>[out] Receives a reference to the <see cref="T:SharpDX.MediaFoundation.Sample"/> Interface. The caller must release the interface.</p> <p>The method returns an <see cref="T:SharpDX.Result"/>. Possible values include, but are not limited to, those in the following table.</p> <table><tr> <th> Return code </th> <th> Description </th> </tr><tr> <td> <p><see cref="F:SharpDX.Result.Ok"/></p> </td> <td> <p>The method succeeded.</p> </td> </tr><tr> <td> <p>MF_E_SAMPLEALLOCATOR_EMPTY</p> </td> <td> <p>No samples are available.</p> </td> </tr></table> <p> Client: Requires Windows Vista.</p> <p> Header: Include mfidl.h.</p> <p> Library: Use mfuuid.lib.</p> ReferenceIMFVideoSampleAllocator Interface
|
|
</summary>
|
|
<param name="sampleOut">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='IMFVideoSampleAllocator::AllocateSample']/*"/>
|
|
<msdn-id>aa473828</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoSampleAllocator::AllocateSample([In] IMFSample** ppSample)</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocator::AllocateSample</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoSampleAllocator.DirectXManager">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Specifies the Direct3D device manager for the video media sink to use.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The media sink uses the Direct3D device manager to obtain a reference to the Direct3D device, which it uses to allocate Direct3D surfaces. The device manager enables multiple objects in the pipeline (such as a video renderer and a video decoder) to share the same Direct3D device.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocator::SetDirectXManager']/*"/>
|
|
<msdn-id>aa473819</msdn-id>
|
|
<unmanaged>SetDirectXManager</unmanaged>
|
|
<unmanaged-short>SetDirectXManager</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoSampleAllocator::SetDirectXManager([In] IUnknown* pManager)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoSampleAllocatorCallback">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Sets the callback object that receives notification whenever a video sample is returned to the allocator.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To get a video sample from the allocator, call the <strong><see cref="M:SharpDX.MediaFoundation.VideoSampleAllocator.AllocateSample(SharpDX.MediaFoundation.Sample@)"/></strong> method. When the sample is released, it returns to the pool of available samples. When this happens, the allocator invokes the <strong><see cref="M:SharpDX.MediaFoundation.VideoSampleAllocatorNotify.NotifyRelease"/></strong> callback.</p><p>The allocator holds at most one callback reference. Calling this method again replaces the previous callback reference.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocatorCallback']/*"/>
|
|
<msdn-id>dd374904</msdn-id>
|
|
<unmanaged>IMFVideoSampleAllocatorCallback</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocatorCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocatorCallback.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorCallback"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocatorCallback.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoSampleAllocatorCallback">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorCallback"/>. (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.MediaFoundation.VideoSampleAllocatorCallback.SetCallback(SharpDX.MediaFoundation.VideoSampleAllocatorNotify)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Sets the callback object that receives notification whenever a video sample is returned to the allocator.</p>
|
|
</summary>
|
|
<param name="notifyRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorNotify"/></strong> interface that receives notification, or <strong><c>null</c></strong> to remove the callback.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To get a video sample from the allocator, call the <strong><see cref="M:SharpDX.MediaFoundation.VideoSampleAllocator.AllocateSample(SharpDX.MediaFoundation.Sample@)"/></strong> method. When the sample is released, it returns to the pool of available samples. When this happens, the allocator invokes the <strong><see cref="M:SharpDX.MediaFoundation.VideoSampleAllocatorNotify.NotifyRelease"/></strong> callback.</p><p>The allocator holds at most one callback reference. Calling this method again replaces the previous callback reference.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocatorCallback::SetCallback']/*"/>
|
|
<msdn-id>dd374904</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoSampleAllocatorCallback::SetCallback([In] IMFVideoSampleAllocatorNotify* pNotify)</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocatorCallback::SetCallback</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocatorCallback.GetFreeSampleCount(System.Int32)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Gets the number of video samples that are currently available for use.</p>
|
|
</summary>
|
|
<param name="lSamplesRef"><dd> <p>Receives the number of available samples.</p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To get a video sample from the allocator, call the <strong><see cref="M:SharpDX.MediaFoundation.VideoSampleAllocator.AllocateSample(SharpDX.MediaFoundation.Sample@)"/></strong> method. The <strong>AllocateSample</strong> method removes a sample from the sample pool and returns it to the caller. When a sample is released, it returns to the pool. The <strong>GetFreeSampleCount</strong> method returns the count of samples that remain in the sample pool.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocatorCallback::GetFreeSampleCount']/*"/>
|
|
<msdn-id>dd374902</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoSampleAllocatorCallback::GetFreeSampleCount([In] int* plSamples)</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocatorCallback::GetFreeSampleCount</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoSampleAllocatorCallback.Callback">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Sets the callback object that receives notification whenever a video sample is returned to the allocator.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To get a video sample from the allocator, call the <strong><see cref="M:SharpDX.MediaFoundation.VideoSampleAllocator.AllocateSample(SharpDX.MediaFoundation.Sample@)"/></strong> method. When the sample is released, it returns to the pool of available samples. When this happens, the allocator invokes the <strong><see cref="M:SharpDX.MediaFoundation.VideoSampleAllocatorNotify.NotifyRelease"/></strong> callback.</p><p>The allocator holds at most one callback reference. Calling this method again replaces the previous callback reference.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocatorCallback::SetCallback']/*"/>
|
|
<msdn-id>dd374904</msdn-id>
|
|
<unmanaged>SetCallback</unmanaged>
|
|
<unmanaged-short>SetCallback</unmanaged-short>
|
|
<unmanaged>HRESULT IMFVideoSampleAllocatorCallback::SetCallback([In] IMFVideoSampleAllocatorNotify* pNotify)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoSampleAllocatorEx">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Allocates video samples that contain Microsoft Direct3D?11 texture surfaces.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>You can use this interface to allocateDirect3D?11 video samples, rather than allocate the texture surfaces and media samples directly. To get a reference to this interface, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoSampleAllocatorEx(System.Guid,System.IntPtr@)"/></strong> function. </p><p>To allocate video samples, perform the following steps:</p><ol> <li>Obtain a reference to the <strong><see cref="T:SharpDX.MediaFoundation.DXGIDeviceManager"/></strong> interface. For a Media Foundation transform (MFT), this step occurs during the <strong><see cref="F:SharpDX.MediaFoundation.TMessageType.SetD3DManager"/></strong> event.</li> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateVideoSampleAllocatorEx(System.Guid,System.IntPtr@)"/></strong> to create the allocator object and get a reference to the <strong><see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorEx"/></strong> interface.</li> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.VideoSampleAllocator.SetDirectXManager(SharpDX.ComObject)"/></strong> on the allocator to set the <strong><see cref="T:SharpDX.MediaFoundation.DXGIDeviceManager"/></strong> reference on the allocator.</li> <li>Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAttributes(SharpDX.MediaFoundation.MediaAttributes,System.Int32)"/></strong> to get a reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface.</li> <li>Set the <see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.D3D11Usage"/> and <see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.D3D11Bindflags"/> attributes.</li> <li>Call <strong>IMFVideoSampleAllocator::InitializeSampleAllocatorEx</strong>.</li> </ol>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocatorEx']/*"/>
|
|
<msdn-id>hh448076</msdn-id>
|
|
<unmanaged>IMFVideoSampleAllocatorEx</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocatorEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocatorEx.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorEx"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocatorEx.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoSampleAllocatorEx">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorEx"/>. (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.MediaFoundation.VideoSampleAllocatorEx.InitializeSampleAllocatorEx(System.Int32,System.Int32,SharpDX.MediaFoundation.MediaAttributes,SharpDX.MediaFoundation.MediaType)">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes the video sample allocator object.</p>
|
|
</summary>
|
|
<param name="cInitialSamples"><dd> <p>The initial number of samples to allocate. </p> </dd></param>
|
|
<param name="cMaximumSamples"><dd> <p>The maximum number of samples to allocate.</p> </dd></param>
|
|
<param name="attributesRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes"/></strong> interface. You can use this interface to configure the allocator. Currently, the following configuration attributes are defined:</p> <ul> <li> <see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.BuffersPerSample"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.D3D11Bindflags"/> </li> <li> <see cref="F:SharpDX.MediaFoundation.TransformAttributeKeys.D3D11Usage"/> </li> </ul> </dd></param>
|
|
<param name="mediaTypeRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface of a media type that describes the video format. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocatorEx::InitializeSampleAllocatorEx']/*"/>
|
|
<msdn-id>hh448077</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoSampleAllocatorEx::InitializeSampleAllocatorEx([In] unsigned int cInitialSamples,[In] unsigned int cMaximumSamples,[In, Optional] IMFAttributes* pAttributes,[In] IMFMediaType* pMediaType)</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocatorEx::InitializeSampleAllocatorEx</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoSampleAllocatorNotify">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>The callback for the <strong><see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorCallback"/></strong> interface.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocatorNotify']/*"/>
|
|
<msdn-id>dd374906</msdn-id>
|
|
<unmanaged>IMFVideoSampleAllocatorNotify</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocatorNotify</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocatorNotify.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorNotify"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.VideoSampleAllocatorNotify.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.VideoSampleAllocatorNotify">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.VideoSampleAllocatorNotify"/>. (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.MediaFoundation.VideoSampleAllocatorNotify.NotifyRelease">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Called when a video sample is returned to the allocator.</p>
|
|
</summary>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>To get a video sample from the allocator, call the <strong><see cref="M:SharpDX.MediaFoundation.VideoSampleAllocator.AllocateSample(SharpDX.MediaFoundation.Sample@)"/></strong> method. When the sample is released and then returned to the pool of available samples, the allocator invokes the <strong>NotifyRelease</strong> method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFVideoSampleAllocatorNotify::NotifyRelease']/*"/>
|
|
<msdn-id>dd374908</msdn-id>
|
|
<unmanaged>HRESULT IMFVideoSampleAllocatorNotify::NotifyRelease()</unmanaged>
|
|
<unmanaged-short>IMFVideoSampleAllocatorNotify::NotifyRelease</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.WorkQueueServices">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Registers the topology work queues with the Multimedia Class Scheduler Service (MMCSS).</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Each source node in the topology defines one branch of the topology. The branch includes every topology node that receives data from that node. An application can assign each branch of a topology its own work queue and then associate those work queues with MMCSS tasks. </p><p>To use this method, perform the following steps.</p><ol> <li>Create the topology.</li> <li>Set the following attributes on the source nodes in the topology.<ul> <li> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueId"/></strong>. Specifies an identifier for the work queue. The Media Session will allocate a new work queue.</li> <li> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueMmcssClass"/></strong>. Specifies the MMCSS class. </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueMmcssTaskid"/></strong>. Specifies the MMCSS task identifier (optional). If this attribute is not set, MMCSS assigns a new task identifier. </li> </ul> </li> <li>Queue the topology by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.SetTopology(System.Int32,SharpDX.MediaFoundation.Topology)"/></strong>.</li> <li>Wait for the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologyStatus"/> event with the <strong><see cref="F:SharpDX.MediaFoundation.Topostatus.Ready"/></strong> status.</li> <li>Call <strong>BeginRegisterTopologyWorkQueuesWithMMCSS</strong>. This method registers all of the topology work queues with MMCSS.</li> </ol><p>The <strong>BeginRegisterTopologyWorkQueuesWithMMCSS</strong> method is asynchronous. When the operation completes, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. Within the callback method, call <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.EndRegisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncResult)"/></strong> to complete the asynchronous request. After this operation completes, the Media Session automatically registers the work queues for every new topology that is queued on the Media Session. The application does not need to call the method again for new topologies.</p><p>To unregister the topology work queues from MMCSS, call <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginUnregisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices']/*"/>
|
|
<msdn-id>ms697485</msdn-id>
|
|
<unmanaged>IMFWorkQueueServices</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.WorkQueueServices"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.WorkQueueServices">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.WorkQueueServices"/>. (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.MediaFoundation.WorkQueueServices.BeginRegisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Registers the topology work queues with the Multimedia Class Scheduler Service (MMCSS).</p>
|
|
</summary>
|
|
<param name="callbackRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface. </p> </dd></param>
|
|
<param name="stateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>Each source node in the topology defines one branch of the topology. The branch includes every topology node that receives data from that node. An application can assign each branch of a topology its own work queue and then associate those work queues with MMCSS tasks. </p><p>To use this method, perform the following steps.</p><ol> <li>Create the topology.</li> <li>Set the following attributes on the source nodes in the topology.<ul> <li> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueId"/></strong>. Specifies an identifier for the work queue. The Media Session will allocate a new work queue.</li> <li> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueMmcssClass"/></strong>. Specifies the MMCSS class. </li> <li> <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueMmcssTaskid"/></strong>. Specifies the MMCSS task identifier (optional). If this attribute is not set, MMCSS assigns a new task identifier. </li> </ul> </li> <li>Queue the topology by calling <strong><see cref="M:SharpDX.MediaFoundation.MediaSession.SetTopology(System.Int32,SharpDX.MediaFoundation.Topology)"/></strong>.</li> <li>Wait for the <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionTopologyStatus"/> event with the <strong><see cref="F:SharpDX.MediaFoundation.Topostatus.Ready"/></strong> status.</li> <li>Call <strong>BeginRegisterTopologyWorkQueuesWithMMCSS</strong>. This method registers all of the topology work queues with MMCSS.</li> </ol><p>The <strong>BeginRegisterTopologyWorkQueuesWithMMCSS</strong> method is asynchronous. When the operation completes, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. Within the callback method, call <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.EndRegisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncResult)"/></strong> to complete the asynchronous request. After this operation completes, the Media Session automatically registers the work queues for every new topology that is queued on the Media Session. The application does not need to call the method again for new topologies.</p><p>To unregister the topology work queues from MMCSS, call <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginUnregisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::BeginRegisterTopologyWorkQueuesWithMMCSS']/*"/>
|
|
<msdn-id>ms697485</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::BeginRegisterTopologyWorkQueuesWithMMCSS([In] IMFAsyncCallback* pCallback,[In] IUnknown* pState)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::BeginRegisterTopologyWorkQueuesWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.EndRegisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Completes an asynchronous request to register the topology work queues with the Multimedia Class Scheduler Service (MMCSS).</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method when the <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginRegisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::EndRegisterTopologyWorkQueuesWithMMCSS']/*"/>
|
|
<msdn-id>ms696983</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::EndRegisterTopologyWorkQueuesWithMMCSS([In] IMFAsyncResult* pResult)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::EndRegisterTopologyWorkQueuesWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.BeginUnregisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Unregisters the topology work queues from the Multimedia Class Scheduler Service (MMCSS).</p>
|
|
</summary>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface.</p> </dd></param>
|
|
<param name="stateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is asynchronous. When the operation completes, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.EndUnregisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncResult)"/></strong> to complete the asynchronous request.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::BeginUnregisterTopologyWorkQueuesWithMMCSS']/*"/>
|
|
<msdn-id>ms702139</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::BeginUnregisterTopologyWorkQueuesWithMMCSS([In] IMFAsyncCallback* pCallback,[In] IUnknown* pState)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::BeginUnregisterTopologyWorkQueuesWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.EndUnregisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Completes an asynchronous request to unregister the topology work queues from the Multimedia Class Scheduler Service (MMCSS).</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method when the <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginRegisterTopologyWorkQueuesWithMMCSS(SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::EndUnregisterTopologyWorkQueuesWithMMCSS']/*"/>
|
|
<msdn-id>ms698872</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::EndUnregisterTopologyWorkQueuesWithMMCSS([In] IMFAsyncResult* pResult)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::EndUnregisterTopologyWorkQueuesWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.GetTopologyWorkQueueMMCSSClass(System.Int32,System.IntPtr,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the Multimedia Class Scheduler Service (MMCSS) class for a specified branch of the current topology.</p>
|
|
</summary>
|
|
<param name="dwTopologyWorkQueueId"><dd> <p>Identifies the work queue assigned to this topology branch. The application defines this value by setting the <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueId"/></strong> attribute on the source node for the branch.</p> </dd></param>
|
|
<param name="wszClassRef"><dd> <p>Pointer to a buffer that receives the name of the MMCSS class. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="cchClassRef"><dd> <p>On input, specifies the size of the <em>pwszClass</em> buffer, in characters. On output, receives the required size of the buffer, in characters. The size includes the terminating null character.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>E_INVALIDARG</strong></dt> </dl> </td><td> <p>There is no work queue with the specified identifier.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BUFFERTOOSMALL</strong></dt> </dl> </td><td> <p>The <em>pwszClass</em> buffer is too small to receive the class name.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::GetTopologyWorkQueueMMCSSClass']/*"/>
|
|
<msdn-id>ms704762</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::GetTopologyWorkQueueMMCSSClass([In] unsigned int dwTopologyWorkQueueId,[Out, Buffer] wchar_t* pwszClass,[InOut] unsigned int* pcchClass)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::GetTopologyWorkQueueMMCSSClass</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.GetTopologyWorkQueueMMCSSTaskId(System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the Multimedia Class Scheduler Service (MMCSS) task identifier for a specified branch of the current topology.</p>
|
|
</summary>
|
|
<param name="dwTopologyWorkQueueId"><dd> <p>Identifies the work queue assigned to this topology branch. The application defines this value by setting the <strong><see cref="F:SharpDX.MediaFoundation.TopologyNodeAttributeKeys.WorkqueueId"/></strong> attribute on the source node for the branch.</p> </dd></param>
|
|
<param name="dwTaskIdRef"><dd> <p>Receives the task identifier.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::GetTopologyWorkQueueMMCSSTaskId']/*"/>
|
|
<msdn-id>ms694202</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::GetTopologyWorkQueueMMCSSTaskId([In] unsigned int dwTopologyWorkQueueId,[Out] unsigned int* pdwTaskId)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::GetTopologyWorkQueueMMCSSTaskId</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.BeginRegisterPlatformWorkQueueWithMMCSS(System.Int32,System.String,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Associates a platform work queue with a Multimedia Class Scheduler Service (MMCSS) task. </p>
|
|
</summary>
|
|
<param name="dwPlatformWorkQueue"><dd> <p> The platform work queue to register with MMCSS. See Work Queue Identifiers. To register all of the standard work queues to the same MMCSS task, set this parameter to <strong>MFASYNC_CALLBACK_QUEUE_ALL</strong>.</p> </dd></param>
|
|
<param name="wszClass"><dd> <p>The name of the MMCSS task to be performed. </p> </dd></param>
|
|
<param name="dwTaskId"><dd> <p> The unique task identifier. To obtain a new task identifier, set this value to zero. </p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface. </p> </dd></param>
|
|
<param name="stateRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked. </p> </dd></param>
|
|
<returns><p>If this method succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This method is asynchronous. When the operation completes, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.EndRegisterPlatformWorkQueueWithMMCSS(SharpDX.MediaFoundation.AsyncResult,System.Int32@)"/></strong> to complete the asynchronous request.</p><p>To unregister the work queue from the MMCSS class, call <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginUnregisterPlatformWorkQueueWithMMCSS(System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::BeginRegisterPlatformWorkQueueWithMMCSS']/*"/>
|
|
<msdn-id>ms702114</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::BeginRegisterPlatformWorkQueueWithMMCSS([In] unsigned int dwPlatformWorkQueue,[In] const wchar_t* wszClass,[In] unsigned int dwTaskId,[In] IMFAsyncCallback* pCallback,[In] IUnknown* pState)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::BeginRegisterPlatformWorkQueueWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.EndRegisterPlatformWorkQueueWithMMCSS(SharpDX.MediaFoundation.AsyncResult,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Completes an asynchronous request to associate a platform work queue with a Multimedia Class Scheduler Service (MMCSS) task.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p> </dd></param>
|
|
<param name="dwTaskIdRef"><dd> <p>The unique task identifier.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this function when the <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginRegisterPlatformWorkQueueWithMMCSS(System.Int32,System.String,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously.</p><p>To unregister the work queue from the MMCSS class, call <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginUnregisterPlatformWorkQueueWithMMCSS(System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::EndRegisterPlatformWorkQueueWithMMCSS']/*"/>
|
|
<msdn-id>ms702284</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::EndRegisterPlatformWorkQueueWithMMCSS([In] IMFAsyncResult* pResult,[Out] unsigned int* pdwTaskId)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::EndRegisterPlatformWorkQueueWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.BeginUnregisterPlatformWorkQueueWithMMCSS(System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Unregisters a platform work queue from a Multimedia Class Scheduler Service (MMCSS) task.</p>
|
|
</summary>
|
|
<param name="dwPlatformWorkQueue"><dd> <p>Platform work queue to register with MMCSS. See <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginRegisterPlatformWorkQueueWithMMCSS(System.Int32,System.String,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p> </dd></param>
|
|
<param name="callbackRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncCallback"/></strong> interface of a callback object. The caller must implement this interface.</p> </dd></param>
|
|
<param name="stateRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of a state object, defined by the caller. This parameter can be <strong><c>null</c></strong>. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>This method is asynchronous. When the operation completes, the callback object's <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.EndUnregisterPlatformWorkQueueWithMMCSS(SharpDX.MediaFoundation.AsyncResult)"/></strong> to complete the asynchronous request.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::BeginUnregisterPlatformWorkQueueWithMMCSS']/*"/>
|
|
<msdn-id>ms704603</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::BeginUnregisterPlatformWorkQueueWithMMCSS([In] unsigned int dwPlatformWorkQueue,[In] IMFAsyncCallback* pCallback,[In] IUnknown* pState)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::BeginUnregisterPlatformWorkQueueWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.EndUnregisterPlatformWorkQueueWithMMCSS(SharpDX.MediaFoundation.AsyncResult)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Completes an asynchronous request to unregister a platform work queue from a Multimedia Class Scheduler Service (MMCSS) task.</p>
|
|
</summary>
|
|
<param name="resultRef"><dd> <p>Pointer to the <strong><see cref="T:SharpDX.MediaFoundation.AsyncResult"/></strong> interface. Pass in the same reference that your callback object received in the <strong><see cref="M:SharpDX.MediaFoundation.AsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<remarks>
|
|
<p>Call this method when the <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginUnregisterPlatformWorkQueueWithMMCSS(System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong> method completes asynchronously.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::EndUnregisterPlatformWorkQueueWithMMCSS']/*"/>
|
|
<msdn-id>ms704734</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::EndUnregisterPlatformWorkQueueWithMMCSS([In] IMFAsyncResult* pResult)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::EndUnregisterPlatformWorkQueueWithMMCSS</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.GetPlaftormWorkQueueMMCSSClass(System.Int32,System.IntPtr,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the Multimedia Class Scheduler Service (MMCSS) class for a specified platform work queue.</p>
|
|
</summary>
|
|
<param name="dwPlatformWorkQueueId"><dd> <p>Platform work queue to query. See <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginRegisterPlatformWorkQueueWithMMCSS(System.Int32,System.String,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p> </dd></param>
|
|
<param name="wszClassRef"><dd> <p>Pointer to a buffer that receives the name of the MMCSS class. This parameter can be <strong><c>null</c></strong>.</p> </dd></param>
|
|
<param name="cchClassRef"><dd> <p>On input, specifies the size of the pwszClass buffer, in characters. On output, receives the required size of the buffer, in characters. The size includes the terminating null character.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> <tr><td> <dl> <dt><strong>MF_E_BUFFERTOOSMALL</strong></dt> </dl> </td><td> <p>The <em>pwszClass</em> buffer is too small to receive the class name.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::GetPlaftormWorkQueueMMCSSClass']/*"/>
|
|
<msdn-id>ms705624</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::GetPlaftormWorkQueueMMCSSClass([In] unsigned int dwPlatformWorkQueueId,[Out, Buffer] wchar_t* pwszClass,[InOut] unsigned int* pcchClass)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::GetPlaftormWorkQueueMMCSSClass</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServices.GetPlatformWorkQueueMMCSSTaskId(System.Int32,System.Int32@)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Retrieves the Multimedia Class Scheduler Service (MMCSS) task identifier for a specified platform work queue.</p>
|
|
</summary>
|
|
<param name="dwPlatformWorkQueueId"><dd> <p>Platform work queue to query. See <strong><see cref="M:SharpDX.MediaFoundation.WorkQueueServices.BeginRegisterPlatformWorkQueueWithMMCSS(System.Int32,System.String,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)"/></strong>.</p> </dd></param>
|
|
<param name="dwTaskIdRef"><dd> <p>Receives the task identifier.</p> </dd></param>
|
|
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.Result.Ok"/></strong></dt> </dl> </td><td> <p>The method succeeded.</p> </td></tr> </table><p>?</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServices::GetPlatformWorkQueueMMCSSTaskId']/*"/>
|
|
<msdn-id>ms700183</msdn-id>
|
|
<unmanaged>HRESULT IMFWorkQueueServices::GetPlatformWorkQueueMMCSSTaskId([In] unsigned int dwPlatformWorkQueueId,[Out] unsigned int* pdwTaskId)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServices::GetPlatformWorkQueueMMCSSTaskId</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.WorkQueueServicesEx">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFWorkQueueServicesEx']/*"/>
|
|
<unmanaged>IMFWorkQueueServicesEx</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServicesEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServicesEx.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.WorkQueueServicesEx"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServicesEx.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.WorkQueueServicesEx">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.WorkQueueServicesEx"/>. (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.MediaFoundation.WorkQueueServicesEx.GetTopologyWorkQueueMMCSSPriority(System.Int32,System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwTopologyWorkQueueId">No documentation.</param>
|
|
<param name="lPriorityRef">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='IMFWorkQueueServicesEx::GetTopologyWorkQueueMMCSSPriority']/*"/>
|
|
<unmanaged>HRESULT IMFWorkQueueServicesEx::GetTopologyWorkQueueMMCSSPriority([In] unsigned int dwTopologyWorkQueueId,[Out] int* plPriority)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServicesEx::GetTopologyWorkQueueMMCSSPriority</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServicesEx.BeginRegisterPlatformWorkQueueWithMMCSSEx(System.Int32,System.String,System.Int32,System.Int32,SharpDX.MediaFoundation.AsyncCallback,SharpDX.ComObject)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwPlatformWorkQueue">No documentation.</param>
|
|
<param name="wszClass">No documentation.</param>
|
|
<param name="dwTaskId">No documentation.</param>
|
|
<param name="lPriority">No documentation.</param>
|
|
<param name="callbackRef">No documentation.</param>
|
|
<param name="stateRef">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='IMFWorkQueueServicesEx::BeginRegisterPlatformWorkQueueWithMMCSSEx']/*"/>
|
|
<unmanaged>HRESULT IMFWorkQueueServicesEx::BeginRegisterPlatformWorkQueueWithMMCSSEx([In] unsigned int dwPlatformWorkQueue,[In] const wchar_t* wszClass,[In] unsigned int dwTaskId,[In] int lPriority,[In] IMFAsyncCallback* pCallback,[In] IUnknown* pState)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServicesEx::BeginRegisterPlatformWorkQueueWithMMCSSEx</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.WorkQueueServicesEx.GetPlatformWorkQueueMMCSSPriority(System.Int32,System.Int32@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="dwPlatformWorkQueueId">No documentation.</param>
|
|
<param name="lPriorityRef">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='IMFWorkQueueServicesEx::GetPlatformWorkQueueMMCSSPriority']/*"/>
|
|
<unmanaged>HRESULT IMFWorkQueueServicesEx::GetPlatformWorkQueueMMCSSPriority([In] unsigned int dwPlatformWorkQueueId,[Out] int* plPriority)</unmanaged>
|
|
<unmanaged-short>IMFWorkQueueServicesEx::GetPlatformWorkQueueMMCSSPriority</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Argb">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Copies the current video frame to a DXGI surface or WIC bitmap.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>In frame-server mode, call this method to blit the video frame to a DXGI or WIC surface. The application can call this method at any time after the Media Engine loads a video resource. Typically, however, the application calls <strong>IMFMediaEngine::OnVideoStreamTick</strong> first, to determine whether a new frame is available. If <strong>OnVideoStreamTick</strong> returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>, the application then calls <strong>TransferVideoFrame</strong>.</p><p>The Media Engine scales and letterboxes the video to fit the destination rectangle. It fills the letterbox area with the border color.</p><p>For protected content, call the <strong>IMFMediaEngineProtectedContent::TransferVideoFrame</strong> method instead of this method.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFARGB']/*"/>
|
|
<msdn-id>hh448021</msdn-id>
|
|
<unmanaged>MFARGB</unmanaged>
|
|
<unmanaged-short>MFARGB</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Argb.RgbBlue">
|
|
<summary>
|
|
<dd> <p>A reference to the <strong><see cref="T:SharpDX.ComObject"/></strong> interface of the destination surface. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFARGB::rgbBlue']/*"/>
|
|
<msdn-id>hh448021</msdn-id>
|
|
<unmanaged>unsigned char rgbBlue</unmanaged>
|
|
<unmanaged-short>unsigned char rgbBlue</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Argb.RgbGreen">
|
|
<summary>
|
|
<dd> <p>A reference to an <strong><see cref="T:SharpDX.MediaFoundation.VideoNormalizedRect"/></strong> structure that specifies the source rectangle.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFARGB::rgbGreen']/*"/>
|
|
<msdn-id>hh448021</msdn-id>
|
|
<unmanaged>unsigned char rgbGreen</unmanaged>
|
|
<unmanaged-short>unsigned char rgbGreen</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Argb.RgbRed">
|
|
<summary>
|
|
<dd> <p>A reference to a <strong><see cref="T:SharpDX.Rectangle"/></strong> structure that specifies the destination rectangle.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFARGB::rgbRed']/*"/>
|
|
<msdn-id>hh448021</msdn-id>
|
|
<unmanaged>unsigned char rgbRed</unmanaged>
|
|
<unmanaged-short>unsigned char rgbRed</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Argb.RgbAlpha">
|
|
<summary>
|
|
<dd> <p>A reference to an <strong><see cref="T:SharpDX.MediaFoundation.Argb"/></strong> structure that specifies the border color. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFARGB::rgbAlpha']/*"/>
|
|
<msdn-id>hh448021</msdn-id>
|
|
<unmanaged>unsigned char rgbAlpha</unmanaged>
|
|
<unmanaged-short>unsigned char rgbAlpha</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsfFlatPicture">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains an image that is stored as metadata for a media source. This structure is used as the data item for the <strong>WM/Picture</strong> metadata attribute.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The <strong>WM/Picture</strong> attribute is defined in the Windows Media Format SDK. The attribute contains a picture related to the content, such as album art.</p><p>To get this attribute from a media source, call <strong><see cref="M:SharpDX.MediaFoundation.Metadata.GetProperty(System.String,SharpDX.Win32.Variant@)"/></strong>, passing in the constant g_wszWMPicture for the <em>pwszName</em> parameter. The method retrieves a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that contains a binary array (VT_BLOB). The layout of the array is as follows:</p><ul> <li><strong><see cref="T:SharpDX.MediaFoundation.AsfFlatPicture"/></strong> structure. </li> <li> Null-terminated wide-character string that contains the MIME type. </li> <li> Null-terminated wide-character string that contains a description. </li> <li> <p>Image data.</p> </li> </ul><p>This format differs from the <strong>WM_PICTURE</strong> structure used in the Windows Media Format SDK. The <strong>WM_PICTURE</strong> structure contains internal references to two strings and the image data. If the structure is copied, these references become invalid. The <strong><see cref="T:SharpDX.MediaFoundation.AsfFlatPicture"/></strong> structure does not contain internal references, so it is safe to copy the structure.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_FLAT_PICTURE']/*"/>
|
|
<msdn-id>ms696178</msdn-id>
|
|
<unmanaged>ASF_FLAT_PICTURE</unmanaged>
|
|
<unmanaged-short>ASF_FLAT_PICTURE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfFlatPicture.BPictureType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_FLAT_PICTURE::bPictureType']/*"/>
|
|
<unmanaged>unsigned char bPictureType</unmanaged>
|
|
<unmanaged-short>unsigned char bPictureType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfFlatPicture.DwDataLen">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_FLAT_PICTURE::dwDataLen']/*"/>
|
|
<unmanaged>unsigned int dwDataLen</unmanaged>
|
|
<unmanaged-short>unsigned int dwDataLen</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsfFlatSynchronisedLyrics">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains an image that is stored as metadata for a media source. This structure is used as the data item for the <strong>WM/Picture</strong> metadata attribute.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The <strong>WM/Picture</strong> attribute is defined in the Windows Media Format SDK. The attribute contains a picture related to the content, such as album art.</p><p>To get this attribute from a media source, call <strong><see cref="M:SharpDX.MediaFoundation.Metadata.GetProperty(System.String,SharpDX.Win32.Variant@)"/></strong>, passing in the constant g_wszWMPicture for the <em>pwszName</em> parameter. The method retrieves a <strong><see cref="T:SharpDX.Win32.Variant"/></strong> that contains a binary array (VT_BLOB). The layout of the array is as follows:</p><ul> <li><strong><see cref="T:SharpDX.MediaFoundation.AsfFlatPicture"/></strong> structure. </li> <li> Null-terminated wide-character string that contains the MIME type. </li> <li> Null-terminated wide-character string that contains a description. </li> <li> <p>Image data.</p> </li> </ul><p>This format differs from the <strong>WM_PICTURE</strong> structure used in the Windows Media Format SDK. The <strong>WM_PICTURE</strong> structure contains internal references to two strings and the image data. If the structure is copied, these references become invalid. The <strong><see cref="T:SharpDX.MediaFoundation.AsfFlatPicture"/></strong> structure does not contain internal references, so it is safe to copy the structure.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_FLAT_SYNCHRONISED_LYRICS']/*"/>
|
|
<msdn-id>ms696178</msdn-id>
|
|
<unmanaged>ASF_FLAT_SYNCHRONISED_LYRICS</unmanaged>
|
|
<unmanaged-short>ASF_FLAT_SYNCHRONISED_LYRICS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfFlatSynchronisedLyrics.BTimeStampFormat">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_FLAT_SYNCHRONISED_LYRICS::bTimeStampFormat']/*"/>
|
|
<unmanaged>unsigned char bTimeStampFormat</unmanaged>
|
|
<unmanaged-short>unsigned char bTimeStampFormat</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfFlatSynchronisedLyrics.BContentType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_FLAT_SYNCHRONISED_LYRICS::bContentType']/*"/>
|
|
<unmanaged>unsigned char bContentType</unmanaged>
|
|
<unmanaged-short>unsigned char bContentType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfFlatSynchronisedLyrics.DwLyricsLen">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_FLAT_SYNCHRONISED_LYRICS::dwLyricsLen']/*"/>
|
|
<unmanaged>unsigned int dwLyricsLen</unmanaged>
|
|
<unmanaged-short>unsigned int dwLyricsLen</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsfIndexDescriptor">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies an index for the ASF indexer object. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> The index object of an ASF file can contain a number of distinct indexes. Each index is identified by the type of index and the stream number. No ASF index object can contain more than one index for a particular combination of stream number and index type.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_INDEX_DESCRIPTOR']/*"/>
|
|
<msdn-id>ms700100</msdn-id>
|
|
<unmanaged>ASF_INDEX_DESCRIPTOR</unmanaged>
|
|
<unmanaged-short>ASF_INDEX_DESCRIPTOR</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfIndexDescriptor.Identifier">
|
|
<summary>
|
|
<dd> <p> The type of index. Currently this value must be GUID_NULL, which specifies time-based indexing. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_INDEX_DESCRIPTOR::Identifier']/*"/>
|
|
<msdn-id>ms700100</msdn-id>
|
|
<unmanaged>ASF_INDEX_IDENTIFIER Identifier</unmanaged>
|
|
<unmanaged-short>ASF_INDEX_IDENTIFIER Identifier</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfIndexDescriptor.CPerEntryBytes">
|
|
<summary>
|
|
<dd> <p> The stream number to which this structure applies. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_INDEX_DESCRIPTOR::cPerEntryBytes']/*"/>
|
|
<msdn-id>ms700100</msdn-id>
|
|
<unmanaged>unsigned short cPerEntryBytes</unmanaged>
|
|
<unmanaged-short>unsigned short cPerEntryBytes</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfIndexDescriptor.SzDescription">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_INDEX_DESCRIPTOR::szDescription']/*"/>
|
|
<unmanaged>wchar_t szDescription[32]</unmanaged>
|
|
<unmanaged-short>wchar_t szDescription</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfIndexDescriptor.DwInterval">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_INDEX_DESCRIPTOR::dwInterval']/*"/>
|
|
<unmanaged>unsigned int dwInterval</unmanaged>
|
|
<unmanaged-short>unsigned int dwInterval</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsfIndexIdentifier">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies an index for the ASF indexer object. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> The index object of an ASF file can contain a number of distinct indexes. Each index is identified by the type of index and the stream number. No ASF index object can contain more than one index for a particular combination of stream number and index type.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_INDEX_IDENTIFIER']/*"/>
|
|
<msdn-id>ms700100</msdn-id>
|
|
<unmanaged>ASF_INDEX_IDENTIFIER</unmanaged>
|
|
<unmanaged-short>ASF_INDEX_IDENTIFIER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfIndexIdentifier.GuidIndexType">
|
|
<summary>
|
|
<dd> <p> The type of index. Currently this value must be GUID_NULL, which specifies time-based indexing. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_INDEX_IDENTIFIER::guidIndexType']/*"/>
|
|
<msdn-id>ms700100</msdn-id>
|
|
<unmanaged>GUID guidIndexType</unmanaged>
|
|
<unmanaged-short>GUID guidIndexType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfIndexIdentifier.WStreamNumber">
|
|
<summary>
|
|
<dd> <p> The stream number to which this structure applies. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_INDEX_IDENTIFIER::wStreamNumber']/*"/>
|
|
<msdn-id>ms700100</msdn-id>
|
|
<unmanaged>unsigned short wStreamNumber</unmanaged>
|
|
<unmanaged-short>unsigned short wStreamNumber</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AsfMuxStatistics">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies an index for the ASF indexer object. </p>
|
|
</summary>
|
|
<remarks>
|
|
<p> The index object of an ASF file can contain a number of distinct indexes. Each index is identified by the type of index and the stream number. No ASF index object can contain more than one index for a particular combination of stream number and index type.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_MUX_STATISTICS']/*"/>
|
|
<msdn-id>ms700100</msdn-id>
|
|
<unmanaged>ASF_MUX_STATISTICS</unmanaged>
|
|
<unmanaged-short>ASF_MUX_STATISTICS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfMuxStatistics.CFramesWritten">
|
|
<summary>
|
|
<dd> <p> The type of index. Currently this value must be GUID_NULL, which specifies time-based indexing. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_MUX_STATISTICS::cFramesWritten']/*"/>
|
|
<msdn-id>ms700100</msdn-id>
|
|
<unmanaged>unsigned int cFramesWritten</unmanaged>
|
|
<unmanaged-short>unsigned int cFramesWritten</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AsfMuxStatistics.CFramesDropped">
|
|
<summary>
|
|
<dd> <p> The stream number to which this structure applies. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='ASF_MUX_STATISTICS::cFramesDropped']/*"/>
|
|
<msdn-id>ms700100</msdn-id>
|
|
<unmanaged>unsigned int cFramesDropped</unmanaged>
|
|
<unmanaged-short>unsigned int cFramesDropped</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.AYUVSample">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAYUVSample']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFAYUVSample</unmanaged>
|
|
<unmanaged-short>MFAYUVSample</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AYUVSample.BCrValue">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAYUVSample::bCrValue']/*"/>
|
|
<unmanaged>unsigned char bCrValue</unmanaged>
|
|
<unmanaged-short>unsigned char bCrValue</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AYUVSample.BCbValue">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAYUVSample::bCbValue']/*"/>
|
|
<unmanaged>unsigned char bCbValue</unmanaged>
|
|
<unmanaged-short>unsigned char bCbValue</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AYUVSample.BYValue">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAYUVSample::bYValue']/*"/>
|
|
<unmanaged>unsigned char bYValue</unmanaged>
|
|
<unmanaged-short>unsigned char bYValue</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.AYUVSample.BSampleAlpha8">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFAYUVSample::bSampleAlpha8']/*"/>
|
|
<unmanaged>unsigned char bSampleAlpha8</unmanaged>
|
|
<unmanaged-short>unsigned char bSampleAlpha8</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.BytestreamBufferingParams">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBYTESTREAM_BUFFERING_PARAMS']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFBYTESTREAM_BUFFERING_PARAMS</unmanaged>
|
|
<unmanaged-short>MFBYTESTREAM_BUFFERING_PARAMS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.BytestreamBufferingParams.CbTotalFileSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBYTESTREAM_BUFFERING_PARAMS::cbTotalFileSize']/*"/>
|
|
<unmanaged>unsigned longlong cbTotalFileSize</unmanaged>
|
|
<unmanaged-short>unsigned longlong cbTotalFileSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.BytestreamBufferingParams.CbPlayableDataSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBYTESTREAM_BUFFERING_PARAMS::cbPlayableDataSize']/*"/>
|
|
<unmanaged>unsigned longlong cbPlayableDataSize</unmanaged>
|
|
<unmanaged-short>unsigned longlong cbPlayableDataSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.BytestreamBufferingParams.PrgBuckets">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBYTESTREAM_BUFFERING_PARAMS::prgBuckets']/*"/>
|
|
<unmanaged>MF_LEAKY_BUCKET_PAIR* prgBuckets</unmanaged>
|
|
<unmanaged-short>MF_LEAKY_BUCKET_PAIR prgBuckets</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.BytestreamBufferingParams.CBuckets">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBYTESTREAM_BUFFERING_PARAMS::cBuckets']/*"/>
|
|
<unmanaged>unsigned int cBuckets</unmanaged>
|
|
<unmanaged-short>unsigned int cBuckets</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.BytestreamBufferingParams.QwNetBufferingTime">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBYTESTREAM_BUFFERING_PARAMS::qwNetBufferingTime']/*"/>
|
|
<unmanaged>unsigned longlong qwNetBufferingTime</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwNetBufferingTime</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.BytestreamBufferingParams.QwExtraBufferingTimeDuringSeek">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBYTESTREAM_BUFFERING_PARAMS::qwExtraBufferingTimeDuringSeek']/*"/>
|
|
<unmanaged>unsigned longlong qwExtraBufferingTimeDuringSeek</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwExtraBufferingTimeDuringSeek</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.BytestreamBufferingParams.QwPlayDuration">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBYTESTREAM_BUFFERING_PARAMS::qwPlayDuration']/*"/>
|
|
<unmanaged>unsigned longlong qwPlayDuration</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwPlayDuration</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.BytestreamBufferingParams.DRate">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFBYTESTREAM_BUFFERING_PARAMS::dRate']/*"/>
|
|
<unmanaged>float dRate</unmanaged>
|
|
<unmanaged-short>float dRate</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ByteStreamCacheRange">
|
|
<summary>
|
|
<p>[This documentation is preliminary and is subject to change.]</p><p><strong>Applies to: </strong>desktop apps only</p><p>Specifies a range of bytes.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_BYTE_STREAM_CACHE_RANGE']/*"/>
|
|
<msdn-id>hh162808</msdn-id>
|
|
<unmanaged>MF_BYTE_STREAM_CACHE_RANGE</unmanaged>
|
|
<unmanaged-short>MF_BYTE_STREAM_CACHE_RANGE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ByteStreamCacheRange.QwStartOffset">
|
|
<summary>
|
|
<dd> <p>The offset, in bytes, of the start of the range.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_BYTE_STREAM_CACHE_RANGE::qwStartOffset']/*"/>
|
|
<msdn-id>hh162808</msdn-id>
|
|
<unmanaged>unsigned longlong qwStartOffset</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwStartOffset</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ByteStreamCacheRange.QwEndOffset">
|
|
<summary>
|
|
<dd> <p>The offset, in bytes, of the end of the range.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_BYTE_STREAM_CACHE_RANGE::qwEndOffset']/*"/>
|
|
<msdn-id>hh162808</msdn-id>
|
|
<unmanaged>unsigned longlong qwEndOffset</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwEndOffset</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ClockProperties">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> Defines the properties of a clock. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_PROPERTIES']/*"/>
|
|
<msdn-id>ms695206</msdn-id>
|
|
<unmanaged>MFCLOCK_PROPERTIES</unmanaged>
|
|
<unmanaged-short>MFCLOCK_PROPERTIES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockProperties.QwCorrelationRate">
|
|
<summary>
|
|
<dd> <p> The interval at which the clock correlates its clock time with the system time, in 100-nanosecond units. If the value is zero, the correlation is made whenever the <strong><see cref="M:SharpDX.MediaFoundation.Clock.GetCorrelatedTime(System.Int32,System.Int64@,System.Int64@)"/></strong> method is called. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_PROPERTIES::qwCorrelationRate']/*"/>
|
|
<msdn-id>ms695206</msdn-id>
|
|
<unmanaged>unsigned longlong qwCorrelationRate</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwCorrelationRate</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockProperties.GuidClockId">
|
|
<summary>
|
|
<dd> <p> The unique identifier of the underlying device that provides the time. If two clocks have the same unique identifier, they are based on the same device. If the underlying device is not shared between two clocks, the value can be <strong>GUID_NULL</strong>. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_PROPERTIES::guidClockId']/*"/>
|
|
<msdn-id>ms695206</msdn-id>
|
|
<unmanaged>GUID guidClockId</unmanaged>
|
|
<unmanaged-short>GUID guidClockId</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockProperties.DwClockFlags">
|
|
<summary>
|
|
<dd> <p> A bitwise <strong>OR</strong> of flags from the <strong><see cref="T:SharpDX.MediaFoundation.ClockRelationalFlags"/></strong> enumeration. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_PROPERTIES::dwClockFlags']/*"/>
|
|
<msdn-id>ms695206</msdn-id>
|
|
<unmanaged>unsigned int dwClockFlags</unmanaged>
|
|
<unmanaged-short>unsigned int dwClockFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockProperties.QwClockFrequency">
|
|
<summary>
|
|
<dd> <p> The clock frequency in Hz. A value of <strong>MFCLOCK_FREQUENCY_HNS</strong> means that the clock has a frequency of 10 MHz (100-nanosecond ticks), which is the standard <strong>MFTIME</strong> time unit in Media Foundation. If the <strong><see cref="M:SharpDX.MediaFoundation.Clock.GetClockCharacteristics(System.Int32@)"/></strong> method returns the <strong><see cref="F:SharpDX.MediaFoundation.ClockCharacteristicsFlags.Frequency10mhz"/></strong> flag, the value of this field must be <strong>MFCLOCK_FREQUENCY_HNS</strong>. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_PROPERTIES::qwClockFrequency']/*"/>
|
|
<msdn-id>ms695206</msdn-id>
|
|
<unmanaged>unsigned longlong qwClockFrequency</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwClockFrequency</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockProperties.DwClockTolerance">
|
|
<summary>
|
|
<dd> <p> The amount of inaccuracy that may be present on the clock, in parts per billion (ppb). For example, an inaccuracy of 50 ppb means the clock might drift up to 50 seconds per billion seconds of real time. If the tolerance is not known, the value is <strong>MFCLOCK_TOLERANCE_UNKNOWN</strong>. This constant is equal to 50 parts per million (ppm). </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_PROPERTIES::dwClockTolerance']/*"/>
|
|
<msdn-id>ms695206</msdn-id>
|
|
<unmanaged>unsigned int dwClockTolerance</unmanaged>
|
|
<unmanaged-short>unsigned int dwClockTolerance</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ClockProperties.DwClockJitter">
|
|
<summary>
|
|
<dd> <p> The amount of jitter that may be present, in 100-nanosecond units. Jitter is the variation in the frequency due to sampling the underlying clock. Jitter does not include inaccuracies caused by drift, which is reflected in the value of <strong>dwClockTolerance</strong>. </p> <p> For clocks based on a single device, the minimum jitter is the length of the tick period (the inverse of the frequency). For example, if the frequency is 10 Hz, the jitter is 0.1 second, which is 1,000,000 in <strong>MFTIME</strong> units. This value reflects the fact that the clock might be sampled just before the next tick, resulting in a clock time that is one period less than the actual time. If the frequency is greater than 10 MHz, the jitter should be set to 1 (the minimum value). </p> <p> If a clock's underlying hardware device does not directly time stamp the incoming data, the jitter also includes the time required to dispatch the driver's interrupt service routine (ISR). In that case, the expected jitter should include the following values: </p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>MFCLOCK_JITTER_ISR</strong></dt> </dl> </td><td> <p> Jitter due to time stamping during the device driver's ISR. </p> </td></tr> <tr><td><dl> <dt><strong>MFCLOCK_JITTER_DPC</strong></dt> </dl> </td><td> <p> Jitter due to time stamping during the deferred procedure call (DPC) processing. </p> </td></tr> <tr><td><dl> <dt><strong>MFCLOCK_JITTER_PASSIVE</strong></dt> </dl> </td><td> <p> Jitter due to dropping to normal thread execution before time stamping. </p> </td></tr> </table> <p>?</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFCLOCK_PROPERTIES::dwClockJitter']/*"/>
|
|
<msdn-id>ms695206</msdn-id>
|
|
<unmanaged>unsigned int dwClockJitter</unmanaged>
|
|
<unmanaged-short>unsigned int dwClockJitter</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.DmoMediaType">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>The <strong><see cref="T:SharpDX.MediaFoundation.DmoMediaType"/></strong> structure describes the format of the data used by a stream in a Microsoft DirectX Media Object (DMO).</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure is identical to the DirectShow <strong><see cref="!:SharpDX.Win32.Unsupported.AMMediaType"/></strong> structure. The <strong>bFixedSizeSamples</strong>, <strong>bTemporalCompression</strong>, and <strong>lSampleSize</strong> members are for compatibility with DirectShow. Other DMO clients are not required to use them.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_MEDIA_TYPE']/*"/>
|
|
<msdn-id>dd375504</msdn-id>
|
|
<unmanaged>DMO_MEDIA_TYPE</unmanaged>
|
|
<unmanaged-short>DMO_MEDIA_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoMediaType.Majortype">
|
|
<summary>
|
|
<dd> <p>Major type <see cref="T:System.Guid"/> of the stream.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_MEDIA_TYPE::majortype']/*"/>
|
|
<msdn-id>dd375504</msdn-id>
|
|
<unmanaged>GUID majortype</unmanaged>
|
|
<unmanaged-short>GUID majortype</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoMediaType.Subtype">
|
|
<summary>
|
|
<dd> <p>Subtype <see cref="T:System.Guid"/> of the stream.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_MEDIA_TYPE::subtype']/*"/>
|
|
<msdn-id>dd375504</msdn-id>
|
|
<unmanaged>GUID subtype</unmanaged>
|
|
<unmanaged-short>GUID subtype</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoMediaType.LSampleSize">
|
|
<summary>
|
|
<dd> <p>Size of the sample in bytes. For compressed data, the value can be zero.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_MEDIA_TYPE::lSampleSize']/*"/>
|
|
<msdn-id>dd375504</msdn-id>
|
|
<unmanaged>unsigned int lSampleSize</unmanaged>
|
|
<unmanaged-short>unsigned int lSampleSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoMediaType.Formattype">
|
|
<summary>
|
|
<dd> <p><see cref="T:System.Guid"/> specifying the format type. The <strong>pbFormat</strong> member points to the corresponding format structure. Format types include the following.</p> <table> <tr><th>Format type</th><th>Format structure</th></tr> <tr><td><dl> <dt><strong>FORMAT_DvInfo</strong></dt> </dl> </td><td> <p> <strong>DVINFO</strong> </p> </td></tr> <tr><td><dl> <dt><strong>FORMAT_MPEG2Video</strong></dt> </dl> </td><td> <p> <strong><see cref="!:SharpDX.MediaFoundation.Mpeg2VideoInformation"/></strong> </p> </td></tr> <tr><td><dl> <dt><strong>FORMAT_MPEGVideo</strong></dt> </dl> </td><td> <p> <strong><see cref="!:SharpDX.MediaFoundation.Mpeg1VideoInformation"/></strong> </p> </td></tr> <tr><td><dl> <dt><strong>FORMAT_None</strong></dt> </dl> </td><td> <p>None.</p> </td></tr> <tr><td><dl> <dt><strong>FORMAT_VideoInfo</strong></dt> </dl> </td><td> <p> <strong><see cref="!:SharpDX.Win32.Unsupported.VideoInfoHeader"/></strong> </p> </td></tr> <tr><td><dl> <dt><strong>FORMAT_VideoInfo2</strong></dt> </dl> </td><td> <p> <strong><see cref="!:SharpDX.MediaFoundation.VideoInformationHeader2"/></strong> </p> </td></tr> <tr><td><dl> <dt><strong>FORMAT_WaveFormatEx</strong></dt> </dl> </td><td> <p> <strong><see cref="T:SharpDX.Multimedia.WaveFormat"/></strong> </p> </td></tr> </table> <p>?</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_MEDIA_TYPE::formattype']/*"/>
|
|
<msdn-id>dd375504</msdn-id>
|
|
<unmanaged>GUID formattype</unmanaged>
|
|
<unmanaged-short>GUID formattype</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoMediaType.PUnk">
|
|
<summary>
|
|
<dd> <p>Not used. Set to <strong><c>null</c></strong>.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_MEDIA_TYPE::pUnk']/*"/>
|
|
<msdn-id>dd375504</msdn-id>
|
|
<unmanaged>IUnknown* pUnk</unmanaged>
|
|
<unmanaged-short>IUnknown pUnk</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoMediaType.CbFormat">
|
|
<summary>
|
|
<dd> <p>Size of the format block of the media type.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_MEDIA_TYPE::cbFormat']/*"/>
|
|
<msdn-id>dd375504</msdn-id>
|
|
<unmanaged>unsigned int cbFormat</unmanaged>
|
|
<unmanaged-short>unsigned int cbFormat</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoMediaType.PbFormat">
|
|
<summary>
|
|
<dd> <p>Pointer to the format structure. The structure type is specified by the <strong>formattype</strong> member. The format structure must be present, unless <strong>formattype</strong> is GUID_NULL or FORMAT_None.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_MEDIA_TYPE::pbFormat']/*"/>
|
|
<msdn-id>dd375504</msdn-id>
|
|
<unmanaged>unsigned char* pbFormat</unmanaged>
|
|
<unmanaged-short>unsigned char pbFormat</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.DmoMediaType.BFixedSizeSamples">
|
|
<summary>
|
|
<dd> <p>If <strong>TRUE</strong>, samples are of a fixed size. This field is informational only. For audio, it is generally set to <strong>TRUE</strong>. For video, it is usually <strong>TRUE</strong> for uncompressed video and <strong><see cref="F:SharpDX.Result.False"/></strong> for compressed video.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_MEDIA_TYPE::bFixedSizeSamples']/*"/>
|
|
<msdn-id>dd375504</msdn-id>
|
|
<unmanaged>BOOL bFixedSizeSamples</unmanaged>
|
|
<unmanaged-short>BOOL bFixedSizeSamples</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.DmoMediaType.BTemporalCompression">
|
|
<summary>
|
|
<dd> <p>If <strong>TRUE</strong>, samples are compressed using temporal (interframe) compression. (A value of <strong>TRUE</strong> indicates that not all frames are key frames.) This field is informational only.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_MEDIA_TYPE::bTemporalCompression']/*"/>
|
|
<msdn-id>dd375504</msdn-id>
|
|
<unmanaged>BOOL bTemporalCompression</unmanaged>
|
|
<unmanaged-short>BOOL bTemporalCompression</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.DmoOutputDataBuffer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_DATA_BUFFER']/*"/>
|
|
<unmanaged>DMO_OUTPUT_DATA_BUFFER</unmanaged>
|
|
<unmanaged-short>DMO_OUTPUT_DATA_BUFFER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputDataBuffer.PBuffer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_DATA_BUFFER::pBuffer']/*"/>
|
|
<unmanaged>IMediaBuffer* pBuffer</unmanaged>
|
|
<unmanaged-short>IMediaBuffer pBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputDataBuffer.DwStatus">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_DATA_BUFFER::dwStatus']/*"/>
|
|
<unmanaged>unsigned int dwStatus</unmanaged>
|
|
<unmanaged-short>unsigned int dwStatus</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputDataBuffer.RtTimestamp">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_DATA_BUFFER::rtTimestamp']/*"/>
|
|
<unmanaged>longlong rtTimestamp</unmanaged>
|
|
<unmanaged-short>longlong rtTimestamp</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.DmoOutputDataBuffer.RtTimelength">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DMO_OUTPUT_DATA_BUFFER::rtTimelength']/*"/>
|
|
<unmanaged>longlong rtTimelength</unmanaged>
|
|
<unmanaged-short>longlong rtTimelength</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.FolddownMatrix">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains coefficients used to transform multichannel audio into a smaller number of audio channels. This process is called <em>fold-down</em>.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To specify this information in the media type, set the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioFolddownMatrix"/></strong> attribute.</p><p>The ASF media source supports fold-down from six channels (5.1 audio) to two channels (stereo). It gets the information from the g_wszFold6To2Channels3 attribute in the ASF header. This attribute is documented in the Windows Media Format SDK documentation.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFFOLDDOWN_MATRIX']/*"/>
|
|
<msdn-id>aa369731</msdn-id>
|
|
<unmanaged>MFFOLDDOWN_MATRIX</unmanaged>
|
|
<unmanaged-short>MFFOLDDOWN_MATRIX</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FolddownMatrix.CbSize">
|
|
<summary>
|
|
<dd> <p>Size of the structure, in bytes.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFFOLDDOWN_MATRIX::cbSize']/*"/>
|
|
<msdn-id>aa369731</msdn-id>
|
|
<unmanaged>unsigned int cbSize</unmanaged>
|
|
<unmanaged-short>unsigned int cbSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FolddownMatrix.CSrcChannels">
|
|
<summary>
|
|
<dd> <p>Number of source channels.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFFOLDDOWN_MATRIX::cSrcChannels']/*"/>
|
|
<msdn-id>aa369731</msdn-id>
|
|
<unmanaged>unsigned int cSrcChannels</unmanaged>
|
|
<unmanaged-short>unsigned int cSrcChannels</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FolddownMatrix.CDstChannels">
|
|
<summary>
|
|
<dd> <p>Number of destination channels.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFFOLDDOWN_MATRIX::cDstChannels']/*"/>
|
|
<msdn-id>aa369731</msdn-id>
|
|
<unmanaged>unsigned int cDstChannels</unmanaged>
|
|
<unmanaged-short>unsigned int cDstChannels</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.FolddownMatrix.DwChannelMask">
|
|
<summary>
|
|
<dd> <p>Specifies the assignment of audio channels to speaker positions in the transformed audio. This member is a bitwise <strong>OR</strong> of flags that define the speaker positions. For a list of valid flags, see <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.AudioChannelMask"/></strong> attribute.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFFOLDDOWN_MATRIX::dwChannelMask']/*"/>
|
|
<msdn-id>aa369731</msdn-id>
|
|
<unmanaged>unsigned int dwChannelMask</unmanaged>
|
|
<unmanaged-short>unsigned int dwChannelMask</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.FolddownMatrix.Coeff">
|
|
<summary>
|
|
<dd> <p>Array that contains the fold-down coefficients. The number of coefficients is <strong>cSrcChannels</strong>?<strong>cDstChannels</strong>. If the number of coefficients is less than the size of the array, the remaining elements in the array are ignored. For more information about how the coefficients are applied, see Windows Media Audio Professional Codec Features.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFFOLDDOWN_MATRIX::Coeff']/*"/>
|
|
<msdn-id>aa369731</msdn-id>
|
|
<unmanaged>int Coeff[64]</unmanaged>
|
|
<unmanaged-short>int Coeff</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.InputtrustauthorityAccessAction">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_ACTION']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFINPUTTRUSTAUTHORITY_ACCESS_ACTION</unmanaged>
|
|
<unmanaged-short>MFINPUTTRUSTAUTHORITY_ACCESS_ACTION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.InputtrustauthorityAccessAction.Action">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_ACTION::Action']/*"/>
|
|
<unmanaged>MFPOLICYMANAGER_ACTION Action</unmanaged>
|
|
<unmanaged-short>MFPOLICYMANAGER_ACTION Action</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.InputtrustauthorityAccessAction.PbTicket">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_ACTION::pbTicket']/*"/>
|
|
<unmanaged>unsigned char* pbTicket</unmanaged>
|
|
<unmanaged-short>unsigned char pbTicket</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.InputtrustauthorityAccessAction.CbTicket">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_ACTION::cbTicket']/*"/>
|
|
<unmanaged>unsigned int cbTicket</unmanaged>
|
|
<unmanaged-short>unsigned int cbTicket</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.InputtrustauthorityAccessParams">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS</unmanaged>
|
|
<unmanaged-short>MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.InputtrustauthorityAccessParams.DwSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS::dwSize']/*"/>
|
|
<unmanaged>unsigned int dwSize</unmanaged>
|
|
<unmanaged-short>unsigned int dwSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.InputtrustauthorityAccessParams.DwVer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS::dwVer']/*"/>
|
|
<unmanaged>unsigned int dwVer</unmanaged>
|
|
<unmanaged-short>unsigned int dwVer</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.InputtrustauthorityAccessParams.CbSignatureOffset">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS::cbSignatureOffset']/*"/>
|
|
<unmanaged>unsigned int cbSignatureOffset</unmanaged>
|
|
<unmanaged-short>unsigned int cbSignatureOffset</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.InputtrustauthorityAccessParams.CbSignatureSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS::cbSignatureSize']/*"/>
|
|
<unmanaged>unsigned int cbSignatureSize</unmanaged>
|
|
<unmanaged-short>unsigned int cbSignatureSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.InputtrustauthorityAccessParams.CbExtensionOffset">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS::cbExtensionOffset']/*"/>
|
|
<unmanaged>unsigned int cbExtensionOffset</unmanaged>
|
|
<unmanaged-short>unsigned int cbExtensionOffset</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.InputtrustauthorityAccessParams.CbExtensionSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS::cbExtensionSize']/*"/>
|
|
<unmanaged>unsigned int cbExtensionSize</unmanaged>
|
|
<unmanaged-short>unsigned int cbExtensionSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.InputtrustauthorityAccessParams.CActions">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS::cActions']/*"/>
|
|
<unmanaged>unsigned int cActions</unmanaged>
|
|
<unmanaged-short>unsigned int cActions</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.InputtrustauthorityAccessParams.RgOutputActions">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFINPUTTRUSTAUTHORITY_ACCESS_PARAMS::rgOutputActions']/*"/>
|
|
<unmanaged>MFINPUTTRUSTAUTHORITY_ACCESS_ACTION rgOutputActions[1]</unmanaged>
|
|
<unmanaged-short>MFINPUTTRUSTAUTHORITY_ACCESS_ACTION rgOutputActions</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.LeakyBucketPair">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_LEAKY_BUCKET_PAIR']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MF_LEAKY_BUCKET_PAIR</unmanaged>
|
|
<unmanaged-short>MF_LEAKY_BUCKET_PAIR</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.LeakyBucketPair.DwBitrate">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_LEAKY_BUCKET_PAIR::dwBitrate']/*"/>
|
|
<unmanaged>unsigned int dwBitrate</unmanaged>
|
|
<unmanaged-short>unsigned int dwBitrate</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.LeakyBucketPair.MsBufferWindow">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_LEAKY_BUCKET_PAIR::msBufferWindow']/*"/>
|
|
<unmanaged>unsigned int msBufferWindow</unmanaged>
|
|
<unmanaged-short>unsigned int msBufferWindow</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Mpeg2dlnasinkstats">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFMPEG2DLNASINKSTATS</unmanaged>
|
|
<unmanaged-short>MFMPEG2DLNASINKSTATS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.CBytesWritten">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::cBytesWritten']/*"/>
|
|
<unmanaged>unsigned longlong cBytesWritten</unmanaged>
|
|
<unmanaged-short>unsigned longlong cBytesWritten</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.FccVideo">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::fccVideo']/*"/>
|
|
<unmanaged>unsigned int fccVideo</unmanaged>
|
|
<unmanaged-short>unsigned int fccVideo</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.DwVideoWidth">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::dwVideoWidth']/*"/>
|
|
<unmanaged>unsigned int dwVideoWidth</unmanaged>
|
|
<unmanaged-short>unsigned int dwVideoWidth</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.DwVideoHeight">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::dwVideoHeight']/*"/>
|
|
<unmanaged>unsigned int dwVideoHeight</unmanaged>
|
|
<unmanaged-short>unsigned int dwVideoHeight</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.CVideoFramesReceived">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::cVideoFramesReceived']/*"/>
|
|
<unmanaged>unsigned longlong cVideoFramesReceived</unmanaged>
|
|
<unmanaged-short>unsigned longlong cVideoFramesReceived</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.CVideoFramesEncoded">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::cVideoFramesEncoded']/*"/>
|
|
<unmanaged>unsigned longlong cVideoFramesEncoded</unmanaged>
|
|
<unmanaged-short>unsigned longlong cVideoFramesEncoded</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.CVideoFramesSkipped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::cVideoFramesSkipped']/*"/>
|
|
<unmanaged>unsigned longlong cVideoFramesSkipped</unmanaged>
|
|
<unmanaged-short>unsigned longlong cVideoFramesSkipped</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.CBlackVideoFramesEncoded">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::cBlackVideoFramesEncoded']/*"/>
|
|
<unmanaged>unsigned longlong cBlackVideoFramesEncoded</unmanaged>
|
|
<unmanaged-short>unsigned longlong cBlackVideoFramesEncoded</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.CVideoFramesDuplicated">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::cVideoFramesDuplicated']/*"/>
|
|
<unmanaged>unsigned longlong cVideoFramesDuplicated</unmanaged>
|
|
<unmanaged-short>unsigned longlong cVideoFramesDuplicated</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.CAudioSamplesPerSec">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::cAudioSamplesPerSec']/*"/>
|
|
<unmanaged>unsigned int cAudioSamplesPerSec</unmanaged>
|
|
<unmanaged-short>unsigned int cAudioSamplesPerSec</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.CAudioChannels">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::cAudioChannels']/*"/>
|
|
<unmanaged>unsigned int cAudioChannels</unmanaged>
|
|
<unmanaged-short>unsigned int cAudioChannels</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.CAudioBytesReceived">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::cAudioBytesReceived']/*"/>
|
|
<unmanaged>unsigned longlong cAudioBytesReceived</unmanaged>
|
|
<unmanaged-short>unsigned longlong cAudioBytesReceived</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.CAudioFramesEncoded">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::cAudioFramesEncoded']/*"/>
|
|
<unmanaged>unsigned longlong cAudioFramesEncoded</unmanaged>
|
|
<unmanaged-short>unsigned longlong cAudioFramesEncoded</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.Mpeg2dlnasinkstats.FPAL">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFMPEG2DLNASINKSTATS::fPAL']/*"/>
|
|
<unmanaged>BOOL fPAL</unmanaged>
|
|
<unmanaged-short>BOOL fPAL</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MtArbitraryHeader">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains format data for a binary stream in an Advanced Streaming Format (ASF) file.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure is used with the <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.ArbitraryHeader"/> media type attribute.</p><p>This structure corresponds to the first 60 bytes of the Type-Specific Data field of the Stream Properties Object, in files where the stream type is ASF_Binary_Media. For more information, see the ASF specification.</p><p>The Format Data field of the Type-Specific Data field is contained in the <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.ArbitraryFormat"/> attribute of the media type.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_ARBITRARY_HEADER']/*"/>
|
|
<msdn-id>dd388931</msdn-id>
|
|
<unmanaged>MT_ARBITRARY_HEADER</unmanaged>
|
|
<unmanaged-short>MT_ARBITRARY_HEADER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtArbitraryHeader.Majortype">
|
|
<summary>
|
|
<dd> <p>Major media type. This value is the <see cref="T:System.Guid"/> stored in the Major Media Type field of the Type-Specific Data field of the ASF file. It might not match the major type <see cref="T:System.Guid"/> from the Media Foundation media type. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_ARBITRARY_HEADER::majortype']/*"/>
|
|
<msdn-id>dd388931</msdn-id>
|
|
<unmanaged>GUID majortype</unmanaged>
|
|
<unmanaged-short>GUID majortype</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtArbitraryHeader.Subtype">
|
|
<summary>
|
|
<dd> <p>Media subtype. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_ARBITRARY_HEADER::subtype']/*"/>
|
|
<msdn-id>dd388931</msdn-id>
|
|
<unmanaged>GUID subtype</unmanaged>
|
|
<unmanaged-short>GUID subtype</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtArbitraryHeader.LSampleSize">
|
|
<summary>
|
|
<dd> <p>If <strong>bFixedSizeSamples</strong> is <strong>TRUE</strong>, this member specifies the sample size in bytes. Otherwise, the value is ignored and should be 0.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_ARBITRARY_HEADER::lSampleSize']/*"/>
|
|
<msdn-id>dd388931</msdn-id>
|
|
<unmanaged>unsigned int lSampleSize</unmanaged>
|
|
<unmanaged-short>unsigned int lSampleSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtArbitraryHeader.Formattype">
|
|
<summary>
|
|
<dd> <p>Format type <see cref="T:System.Guid"/>. This <see cref="T:System.Guid"/> identifies the structure of the additional format data, which is stored in the <see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.ArbitraryFormat"/> attribute of the media type. If no additional format data is present, <strong>formattype</strong> equals GUID_NULL.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_ARBITRARY_HEADER::formattype']/*"/>
|
|
<msdn-id>dd388931</msdn-id>
|
|
<unmanaged>GUID formattype</unmanaged>
|
|
<unmanaged-short>GUID formattype</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MtArbitraryHeader.BFixedSizeSamples">
|
|
<summary>
|
|
<dd> <p>If <strong>TRUE</strong>, samples have a fixed size in bytes. Otherwise, samples have variable size.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_ARBITRARY_HEADER::bFixedSizeSamples']/*"/>
|
|
<msdn-id>dd388931</msdn-id>
|
|
<unmanaged>BOOL bFixedSizeSamples</unmanaged>
|
|
<unmanaged-short>BOOL bFixedSizeSamples</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MtArbitraryHeader.BTemporalCompression">
|
|
<summary>
|
|
<dd> <p> If <strong>TRUE</strong>, the data in this stream uses temporal compression. Otherwise, samples are independent of each other.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_ARBITRARY_HEADER::bTemporalCompression']/*"/>
|
|
<msdn-id>dd388931</msdn-id>
|
|
<unmanaged>BOOL bTemporalCompression</unmanaged>
|
|
<unmanaged-short>BOOL bTemporalCompression</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MtCustomVideoPrimaries">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Defines custom color primaries for a video source. The color primaries define how to convert colors from RGB color space to CIE XYZ color space.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure is used with the <strong><see cref="F:SharpDX.MediaFoundation.MediaTypeAttributeKeys.CustomVideoPrimaries"/></strong> attribute.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_CUSTOM_VIDEO_PRIMARIES']/*"/>
|
|
<msdn-id>ms696187</msdn-id>
|
|
<unmanaged>MT_CUSTOM_VIDEO_PRIMARIES</unmanaged>
|
|
<unmanaged-short>MT_CUSTOM_VIDEO_PRIMARIES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtCustomVideoPrimaries.FRx">
|
|
<summary>
|
|
<dd> <p>Red x-coordinate.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_CUSTOM_VIDEO_PRIMARIES::fRx']/*"/>
|
|
<msdn-id>ms696187</msdn-id>
|
|
<unmanaged>float fRx</unmanaged>
|
|
<unmanaged-short>float fRx</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtCustomVideoPrimaries.FRy">
|
|
<summary>
|
|
<dd> <p>Red y-coordinate.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_CUSTOM_VIDEO_PRIMARIES::fRy']/*"/>
|
|
<msdn-id>ms696187</msdn-id>
|
|
<unmanaged>float fRy</unmanaged>
|
|
<unmanaged-short>float fRy</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtCustomVideoPrimaries.FGx">
|
|
<summary>
|
|
<dd> <p>Green x-coordinate.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_CUSTOM_VIDEO_PRIMARIES::fGx']/*"/>
|
|
<msdn-id>ms696187</msdn-id>
|
|
<unmanaged>float fGx</unmanaged>
|
|
<unmanaged-short>float fGx</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtCustomVideoPrimaries.FGy">
|
|
<summary>
|
|
<dd> <p>Green y-coordinate.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_CUSTOM_VIDEO_PRIMARIES::fGy']/*"/>
|
|
<msdn-id>ms696187</msdn-id>
|
|
<unmanaged>float fGy</unmanaged>
|
|
<unmanaged-short>float fGy</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtCustomVideoPrimaries.FBx">
|
|
<summary>
|
|
<dd> <p>Blue x-coordinate.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_CUSTOM_VIDEO_PRIMARIES::fBx']/*"/>
|
|
<msdn-id>ms696187</msdn-id>
|
|
<unmanaged>float fBx</unmanaged>
|
|
<unmanaged-short>float fBx</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtCustomVideoPrimaries.FBy">
|
|
<summary>
|
|
<dd> <p>Blue y-coordinate.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_CUSTOM_VIDEO_PRIMARIES::fBy']/*"/>
|
|
<msdn-id>ms696187</msdn-id>
|
|
<unmanaged>float fBy</unmanaged>
|
|
<unmanaged-short>float fBy</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtCustomVideoPrimaries.FWx">
|
|
<summary>
|
|
<dd> <p>White point x-coordinate.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_CUSTOM_VIDEO_PRIMARIES::fWx']/*"/>
|
|
<msdn-id>ms696187</msdn-id>
|
|
<unmanaged>float fWx</unmanaged>
|
|
<unmanaged-short>float fWx</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.MtCustomVideoPrimaries.FWy">
|
|
<summary>
|
|
<dd> <p>White point y-coordinate.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MT_CUSTOM_VIDEO_PRIMARIES::fWy']/*"/>
|
|
<msdn-id>ms696187</msdn-id>
|
|
<unmanaged>float fWy</unmanaged>
|
|
<unmanaged-short>float fWy</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NetCredentialManagerGetParam">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialManagerGetParam']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFNetCredentialManagerGetParam</unmanaged>
|
|
<unmanaged-short>MFNetCredentialManagerGetParam</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialManagerGetParam.HrOp">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialManagerGetParam::hrOp']/*"/>
|
|
<unmanaged>HRESULT hrOp</unmanaged>
|
|
<unmanaged-short>HRESULT hrOp</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialManagerGetParam.PszUrl">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialManagerGetParam::pszUrl']/*"/>
|
|
<unmanaged>const wchar_t* pszUrl</unmanaged>
|
|
<unmanaged-short>wchar_t pszUrl</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialManagerGetParam.PszSite">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialManagerGetParam::pszSite']/*"/>
|
|
<unmanaged>const wchar_t* pszSite</unmanaged>
|
|
<unmanaged-short>wchar_t pszSite</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialManagerGetParam.PszRealm">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialManagerGetParam::pszRealm']/*"/>
|
|
<unmanaged>const wchar_t* pszRealm</unmanaged>
|
|
<unmanaged-short>wchar_t pszRealm</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialManagerGetParam.PszPackage">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialManagerGetParam::pszPackage']/*"/>
|
|
<unmanaged>const wchar_t* pszPackage</unmanaged>
|
|
<unmanaged-short>wchar_t pszPackage</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.NetCredentialManagerGetParam.NRetries">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialManagerGetParam::nRetries']/*"/>
|
|
<unmanaged>int nRetries</unmanaged>
|
|
<unmanaged-short>int nRetries</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.NetCredentialManagerGetParam.FAllowLoggedOnUser">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialManagerGetParam::fAllowLoggedOnUser']/*"/>
|
|
<unmanaged>BOOL fAllowLoggedOnUser</unmanaged>
|
|
<unmanaged-short>BOOL fAllowLoggedOnUser</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.NetCredentialManagerGetParam.FClearTextPackage">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFNetCredentialManagerGetParam::fClearTextPackage']/*"/>
|
|
<unmanaged>BOOL fClearTextPackage</unmanaged>
|
|
<unmanaged-short>BOOL fClearTextPackage</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Offset">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies a rectangular area within a video frame. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFOffset']/*"/>
|
|
<msdn-id>ms703850</msdn-id>
|
|
<unmanaged>MFOffset</unmanaged>
|
|
<unmanaged-short>MFOffset</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Offset.Fract">
|
|
<summary>
|
|
<dd> <p> An <strong><see cref="T:SharpDX.MediaFoundation.Offset"/></strong> structure that contains the x-coordinate of the upper-left corner of the rectangle. This coordinate might have a fractional value. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFOffset::fract']/*"/>
|
|
<msdn-id>ms703850</msdn-id>
|
|
<unmanaged>unsigned short fract</unmanaged>
|
|
<unmanaged-short>unsigned short fract</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Offset.Value">
|
|
<summary>
|
|
<dd> <p> An <strong><see cref="T:SharpDX.MediaFoundation.Offset"/></strong> structure that contains the y-coordinate of the upper-left corner of the rectangle. This coordinate might have a fractional value. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFOffset::value']/*"/>
|
|
<msdn-id>ms703850</msdn-id>
|
|
<unmanaged>short value</unmanaged>
|
|
<unmanaged-short>short value</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PAcquireUserCredentialEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFP_ACQUIRE_USER_CREDENTIAL_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_ACQUIRE_USER_CREDENTIAL_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.DwUserData">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::dwUserData']/*"/>
|
|
<unmanaged>ULONG_PTR dwUserData</unmanaged>
|
|
<unmanaged-short>ULONG_PTR dwUserData</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.HrAuthenticationStatus">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::hrAuthenticationStatus']/*"/>
|
|
<unmanaged>HRESULT hrAuthenticationStatus</unmanaged>
|
|
<unmanaged-short>HRESULT hrAuthenticationStatus</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.PwszURL">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::pwszURL']/*"/>
|
|
<unmanaged>const wchar_t* pwszURL</unmanaged>
|
|
<unmanaged-short>wchar_t pwszURL</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.PwszSite">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::pwszSite']/*"/>
|
|
<unmanaged>const wchar_t* pwszSite</unmanaged>
|
|
<unmanaged-short>wchar_t pwszSite</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.PwszRealm">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::pwszRealm']/*"/>
|
|
<unmanaged>const wchar_t* pwszRealm</unmanaged>
|
|
<unmanaged-short>wchar_t pwszRealm</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.PwszPackage">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::pwszPackage']/*"/>
|
|
<unmanaged>const wchar_t* pwszPackage</unmanaged>
|
|
<unmanaged-short>wchar_t pwszPackage</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.NRetries">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::nRetries']/*"/>
|
|
<unmanaged>int nRetries</unmanaged>
|
|
<unmanaged-short>int nRetries</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.Flags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::flags']/*"/>
|
|
<unmanaged>unsigned int flags</unmanaged>
|
|
<unmanaged-short>unsigned int flags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.PCredential">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::pCredential']/*"/>
|
|
<unmanaged>IMFNetCredential* pCredential</unmanaged>
|
|
<unmanaged-short>IMFNetCredential pCredential</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.PAcquireUserCredentialEvent.FProceedWithAuthentication">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ACQUIRE_USER_CREDENTIAL_EVENT::fProceedWithAuthentication']/*"/>
|
|
<unmanaged>BOOL fProceedWithAuthentication</unmanaged>
|
|
<unmanaged-short>BOOL fProceedWithAuthentication</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PaletteEntry">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains one palette entry in a color table.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This union can be used to represent both RGB palettes and Y'Cb'Cr' palettes. The video format that defines the palette determines which union member should be used.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPaletteEntry']/*"/>
|
|
<msdn-id>ms698970</msdn-id>
|
|
<unmanaged>MFPaletteEntry</unmanaged>
|
|
<unmanaged-short>MFPaletteEntry</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PaletteEntry.Argb">
|
|
<summary>
|
|
<dd> <p> <strong><see cref="T:SharpDX.MediaFoundation.Argb"/></strong> structure that contains an RGB color.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPaletteEntry::ARGB']/*"/>
|
|
<msdn-id>ms698970</msdn-id>
|
|
<unmanaged>MFARGB ARGB</unmanaged>
|
|
<unmanaged-short>MFARGB ARGB</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PaletteEntry.AYCbCr">
|
|
<summary>
|
|
<dd> <p> <strong><see cref="T:SharpDX.MediaFoundation.AYUVSample"/></strong> structure that contains a Y'Cb'Cr' color.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFPaletteEntry::AYCbCr']/*"/>
|
|
<msdn-id>ms698970</msdn-id>
|
|
<unmanaged>MFAYUVSample AYCbCr</unmanaged>
|
|
<unmanaged-short>MFAYUVSample AYCbCr</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PErrorEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ERROR_EVENT']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFP_ERROR_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_ERROR_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PErrorEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_ERROR_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PEventHeader">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Contains information that is common to every type of MFPlay event.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_HEADER']/*"/>
|
|
<msdn-id>dd375531</msdn-id>
|
|
<unmanaged>MFP_EVENT_HEADER</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventHeader.EEventType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_HEADER::eEventType']/*"/>
|
|
<unmanaged>MFP_EVENT_TYPE eEventType</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_TYPE eEventType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventHeader.HrEvent">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_HEADER::hrEvent']/*"/>
|
|
<unmanaged>HRESULT hrEvent</unmanaged>
|
|
<unmanaged-short>HRESULT hrEvent</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventHeader.PMediaPlayer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_HEADER::pMediaPlayer']/*"/>
|
|
<unmanaged>IMFPMediaPlayer* pMediaPlayer</unmanaged>
|
|
<unmanaged-short>IMFPMediaPlayer pMediaPlayer</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventHeader.EState">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_HEADER::eState']/*"/>
|
|
<unmanaged>MFP_MEDIAPLAYER_STATE eState</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAPLAYER_STATE eState</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PEventHeader.PPropertyStore">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_EVENT_HEADER::pPropertyStore']/*"/>
|
|
<unmanaged>IPropertyStore* pPropertyStore</unmanaged>
|
|
<unmanaged-short>IPropertyStore pPropertyStore</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PFrameStepEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Event structure for the <strong><see cref="F:SharpDX.MediaFoundation.PEventType.FrameStep"/></strong> event. This event is sent when the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.FrameStep"/></strong> method completes.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To get a reference to this structure, cast the <em>pEventHeader</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> method. You can use the <strong>MFP_GET_FRAME_STEP_EVENT</strong> macro for this purpose.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_FRAME_STEP_EVENT']/*"/>
|
|
<msdn-id>dd375533</msdn-id>
|
|
<unmanaged>MFP_FRAME_STEP_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_FRAME_STEP_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PFrameStepEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_FRAME_STEP_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PFrameStepEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_FRAME_STEP_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMediaitemClearedEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_CLEARED_EVENT']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFP_MEDIAITEM_CLEARED_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAITEM_CLEARED_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaitemClearedEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_CLEARED_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaitemClearedEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_CLEARED_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMediaitemCreatedEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Event structure for the <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemCreated"/></strong> event. This event is sent when the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromURL(System.String,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.CreateMediaItemFromObject(SharpDX.ComObject,System.Boolean,System.IntPtr,SharpDX.MediaFoundation.PMediaItem@)"/></strong> method completes.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To get a reference to this structure, cast the <em>pEventHeader</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> method. You can use the <strong>MFP_GET_MEDIAITEM_CREATED_EVENT</strong> macro for this purpose.</p><p>Media items are created asynchronously. If multiple items are created, the operations can complete in any order, not necessarily in the same order as the method calls. You can use the <strong>dwUserData</strong> member to identify the items, if you have simultaneous requests pending. </p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_CREATED_EVENT']/*"/>
|
|
<msdn-id>dd375560</msdn-id>
|
|
<unmanaged>MFP_MEDIAITEM_CREATED_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAITEM_CREATED_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaitemCreatedEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_CREATED_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaitemCreatedEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_CREATED_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaitemCreatedEvent.DwUserData">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_CREATED_EVENT::dwUserData']/*"/>
|
|
<unmanaged>ULONG_PTR dwUserData</unmanaged>
|
|
<unmanaged-short>ULONG_PTR dwUserData</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMediaitemSetEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Event structure for the <strong><see cref="F:SharpDX.MediaFoundation.PEventType.MediaitemSet"/></strong> event. This event is sent when the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayer.SetMediaItem(SharpDX.MediaFoundation.PMediaItem)"/></strong> method completes.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>To get a reference to this structure, cast the <em>pEventHeader</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> method. You can use the <strong>MFP_GET_MEDIAITEM_SET_EVENT</strong> macro for this purpose.</p><p>If one or more streams could not be connected to a media sink, the event property store contains the MFP_PKEY_StreamRenderingResults property. The value of the property is an array of <strong><see cref="T:SharpDX.Result"/></strong> values, indicating which streams were connected successfully. The event property store can be accessed through the <strong>header.pPropertyStore</strong> member.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_SET_EVENT']/*"/>
|
|
<msdn-id>dd375561</msdn-id>
|
|
<unmanaged>MFP_MEDIAITEM_SET_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_MEDIAITEM_SET_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaitemSetEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_SET_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMediaitemSetEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MEDIAITEM_SET_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PMfEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p><strong>Important</strong>??Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.</p><p>Event structure for the <strong><see cref="F:SharpDX.MediaFoundation.PEventType.Mf"/></strong> event. The MFPlay player object uses this event to forward certain events from the Media Foundation pipeline to the application.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p> To get a reference to this structure, cast the <em>pEventHeader</em> parameter of the <strong><see cref="M:SharpDX.MediaFoundation.PMediaPlayerCallback.OnMediaPlayerEvent(SharpDX.MediaFoundation.PEventHeader@)"/></strong> method. You can use the <strong>MFP_GET_MF_EVENT</strong> macro for this purpose.</p><p>If <strong>MFEventType</strong> is <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkFormatChanged"/>, the following property may be stored in the event property store, which can be accessed through the <strong>header.pPropertyStore</strong> member.</p><table> <tr><th>Property</th><th>Description</th></tr> <tr><td> MFP_PKEY_StreamIndex </td><td>The index of the stream whose format changed. </td></tr> </table><p>?</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MF_EVENT']/*"/>
|
|
<msdn-id>dd375563</msdn-id>
|
|
<unmanaged>MFP_MF_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_MF_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMfEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MF_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMfEvent.MFEventType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MF_EVENT::MFEventType']/*"/>
|
|
<unmanaged>unsigned int MFEventType</unmanaged>
|
|
<unmanaged-short>unsigned int MFEventType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMfEvent.PMFMediaEvent">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MF_EVENT::pMFMediaEvent']/*"/>
|
|
<unmanaged>IMFMediaEvent* pMFMediaEvent</unmanaged>
|
|
<unmanaged-short>IMFMediaEvent pMFMediaEvent</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PMfEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_MF_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PPauseEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_PAUSE_EVENT']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFP_PAUSE_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_PAUSE_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PPauseEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_PAUSE_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PPauseEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_PAUSE_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PPlaybackEndedEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_PLAYBACK_ENDED_EVENT']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFP_PLAYBACK_ENDED_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_PLAYBACK_ENDED_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PPlaybackEndedEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_PLAYBACK_ENDED_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PPlaybackEndedEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_PLAYBACK_ENDED_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PPlayEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_PLAY_EVENT']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFP_PLAY_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_PLAY_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PPlayEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_PLAY_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PPlayEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_PLAY_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PPositionSetEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_POSITION_SET_EVENT']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFP_POSITION_SET_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_POSITION_SET_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PPositionSetEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_POSITION_SET_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PPositionSetEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_POSITION_SET_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PRateSetEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_RATE_SET_EVENT']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFP_RATE_SET_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_RATE_SET_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PRateSetEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_RATE_SET_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PRateSetEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_RATE_SET_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PRateSetEvent.FlRate">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_RATE_SET_EVENT::flRate']/*"/>
|
|
<unmanaged>float flRate</unmanaged>
|
|
<unmanaged-short>float flRate</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.PStopEvent">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_STOP_EVENT']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFP_STOP_EVENT</unmanaged>
|
|
<unmanaged-short>MFP_STOP_EVENT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PStopEvent.Header">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_STOP_EVENT::header']/*"/>
|
|
<unmanaged>MFP_EVENT_HEADER header</unmanaged>
|
|
<unmanaged-short>MFP_EVENT_HEADER header</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.PStopEvent.PMediaItem">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFP_STOP_EVENT::pMediaItem']/*"/>
|
|
<unmanaged>IMFPMediaItem* pMediaItem</unmanaged>
|
|
<unmanaged-short>IMFPMediaItem pMediaItem</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Ratio">
|
|
<summary>
|
|
<p>This topic describes how to create a media type that describes an uncompressed video format. For more information about media types generally, see About Media Types.</p><p>To create a complete uncompressed video type, set the following attributes on the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> interface reference.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRatio']/*"/>
|
|
<msdn-id>ff485865</msdn-id>
|
|
<unmanaged>MFRatio</unmanaged>
|
|
<unmanaged-short>MFRatio</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Ratio.Numerator">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRatio::Numerator']/*"/>
|
|
<unmanaged>unsigned int Numerator</unmanaged>
|
|
<unmanaged-short>unsigned int Numerator</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Ratio.Denominator">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRatio::Denominator']/*"/>
|
|
<unmanaged>unsigned int Denominator</unmanaged>
|
|
<unmanaged-short>unsigned int Denominator</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.RrComponentHashInformation">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains information about a revoked component.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRR_COMPONENT_HASH_INFO']/*"/>
|
|
<msdn-id>aa376487</msdn-id>
|
|
<unmanaged>MFRR_COMPONENT_HASH_INFO</unmanaged>
|
|
<unmanaged-short>MFRR_COMPONENT_HASH_INFO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.RrComponentHashInformation.UlReason">
|
|
<summary>
|
|
<dd> <p>Specifies the reason for the revocation. The following values are defined.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>MF_BOOT_DRIVER_VERIFICATION_FAILED</strong></dt> </dl> </td><td> <p>A boot driver could not be verified.</p> </td></tr> <tr><td><dl> <dt><strong>MF_COMPONENT_CERT_REVOKED</strong></dt> </dl> </td><td> <p>A certificate in a trusted component's certificate chain was revoked.</p> </td></tr> <tr><td><dl> <dt><strong>MF_COMPONENT_HS_CERT_REVOKED</strong></dt> </dl> </td><td> <p>The high-security certificate for authenticating the protected environment (PE) was revoked.</p> <p>The high-security certificate is typically used by ITAs that handle high-definition content and next-generation formats such as HD-DVD.</p> </td></tr> <tr><td><dl> <dt><strong>MF_COMPONENT_INVALID_EKU</strong></dt> </dl> </td><td> <p>A certificate's extended key usage (EKU) object is invalid.</p> </td></tr> <tr><td><dl> <dt><strong>MF_COMPONENT_INVALID_ROOT</strong></dt> </dl> </td><td> <p>The root certificate is not valid.</p> </td></tr> <tr><td><dl> <dt><strong>MF_COMPONENT_LS_CERT_REVOKED</strong></dt> </dl> </td><td> <p>The low-security certificate for authenticating the PE was revoked.</p> <p>The low-security certificate is typically used by ITAs that handle standard-definition content and current-generation formats.</p> </td></tr> <tr><td><dl> <dt><strong>MF_COMPONENT_REVOKED</strong></dt> </dl> </td><td> <p>A trusted component was revoked.</p> </td></tr> <tr><td><dl> <dt><strong>MF_GRL_ABSENT</strong></dt> </dl> </td><td> <p>The GRL was not found.</p> </td></tr> <tr><td><dl> <dt><strong>MF_GRL_LOAD_FAILED</strong></dt> </dl> </td><td> <p>Could not load the global revocation list (GRL).</p> </td></tr> <tr><td><dl> <dt><strong>MF_INVALID_GRL_SIGNATURE</strong></dt> </dl> </td><td> <p>The GRL signature is invalid.</p> </td></tr> <tr><td><dl> <dt><strong>MF_MINCRYPT_FAILURE</strong></dt> </dl> </td><td> <p>A certificate chain was not well-formed, or a boot driver is unsigned or is signed with an untrusted certificate.</p> </td></tr> <tr><td><dl> <dt><strong>MF_TEST_SIGNED_COMPONENT_LOADING</strong></dt> </dl> </td><td> <p>A component was signed by a test certificate.</p> </td></tr> </table> <p>?</p> <p>In addition, one of the following flags might be present, indicating the type of component that failed to load.</p> <table> <tr><th>Value</th><th>Meaning</th></tr> <tr><td><dl> <dt><strong>MF_USER_MODE_COMPONENT_LOAD</strong></dt> </dl> </td><td> <p>User-mode component.</p> </td></tr> <tr><td><dl> <dt><strong>MF_KERNEL_MODE_COMPONENT_LOAD</strong></dt> </dl> </td><td> <p>Kernel-mode component.</p> </td></tr> </table> <p>?</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRR_COMPONENT_HASH_INFO::ulReason']/*"/>
|
|
<msdn-id>aa376487</msdn-id>
|
|
<unmanaged>unsigned int ulReason</unmanaged>
|
|
<unmanaged-short>unsigned int ulReason</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.RrComponentHashInformation.RgHeaderHash">
|
|
<summary>
|
|
<dd> <p>Contains a hash of the file header.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRR_COMPONENT_HASH_INFO::rgHeaderHash']/*"/>
|
|
<msdn-id>aa376487</msdn-id>
|
|
<unmanaged>wchar_t rgHeaderHash[43]</unmanaged>
|
|
<unmanaged-short>wchar_t rgHeaderHash</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.RrComponentHashInformation.RgPublicKeyHash">
|
|
<summary>
|
|
<dd> <p>Contains a hash of the public key in the component's certificate.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRR_COMPONENT_HASH_INFO::rgPublicKeyHash']/*"/>
|
|
<msdn-id>aa376487</msdn-id>
|
|
<unmanaged>wchar_t rgPublicKeyHash[43]</unmanaged>
|
|
<unmanaged-short>wchar_t rgPublicKeyHash</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.RrComponentHashInformation.WszName">
|
|
<summary>
|
|
<dd> <p>File name of the revoked component.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRR_COMPONENT_HASH_INFO::wszName']/*"/>
|
|
<msdn-id>aa376487</msdn-id>
|
|
<unmanaged>wchar_t wszName[260]</unmanaged>
|
|
<unmanaged-short>wchar_t wszName</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.RrComponents">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains information about one or more revoked components.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRR_COMPONENTS']/*"/>
|
|
<msdn-id>aa375568</msdn-id>
|
|
<unmanaged>MFRR_COMPONENTS</unmanaged>
|
|
<unmanaged-short>MFRR_COMPONENTS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.RrComponents.DwRRInfoVersion">
|
|
<summary>
|
|
<dd> <p>Revocation information version.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRR_COMPONENTS::dwRRInfoVersion']/*"/>
|
|
<msdn-id>aa375568</msdn-id>
|
|
<unmanaged>unsigned int dwRRInfoVersion</unmanaged>
|
|
<unmanaged-short>unsigned int dwRRInfoVersion</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.RrComponents.DwRRComponents">
|
|
<summary>
|
|
<dd> <p>Number of elements in the <strong>pRRComponents</strong> array.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRR_COMPONENTS::dwRRComponents']/*"/>
|
|
<msdn-id>aa375568</msdn-id>
|
|
<unmanaged>unsigned int dwRRComponents</unmanaged>
|
|
<unmanaged-short>unsigned int dwRRComponents</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.RrComponents.PRRComponents">
|
|
<summary>
|
|
<dd> <p>Array of <strong><see cref="T:SharpDX.MediaFoundation.RrComponentHashInformation"/></strong> structures.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFRR_COMPONENTS::pRRComponents']/*"/>
|
|
<msdn-id>aa375568</msdn-id>
|
|
<unmanaged>MFRR_COMPONENT_HASH_INFO* pRRComponents</unmanaged>
|
|
<unmanaged-short>MFRR_COMPONENT_HASH_INFO pRRComponents</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.SinkWriterStatistics">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Contains statistics about the performance of the sink writer.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>MF_SINK_WRITER_STATISTICS</unmanaged>
|
|
<unmanaged-short>MF_SINK_WRITER_STATISTICS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.Cb">
|
|
<summary>
|
|
<dd> <p>The size of the structure, in bytes.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::cb']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned int cb</unmanaged>
|
|
<unmanaged-short>unsigned int cb</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.LlLastTimestampReceived">
|
|
<summary>
|
|
<dd> <p>The time stamp of the most recent sample given to the sink writer. The sink writer updates this value each time the application calls <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.WriteSample(System.Int32,SharpDX.MediaFoundation.Sample)"/></strong>.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::llLastTimestampReceived']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>longlong llLastTimestampReceived</unmanaged>
|
|
<unmanaged-short>longlong llLastTimestampReceived</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.LlLastTimestampEncoded">
|
|
<summary>
|
|
<dd> <p>The time stamp of the most recent sample to be encoded. The sink writer updates this value whenever it calls <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong> on the encoder.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::llLastTimestampEncoded']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>longlong llLastTimestampEncoded</unmanaged>
|
|
<unmanaged-short>longlong llLastTimestampEncoded</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.LlLastTimestampProcessed">
|
|
<summary>
|
|
<dd> <p>The time stamp of the most recent sample given to the media sink. The sink writer updates this value whenever it calls <strong><see cref="M:SharpDX.MediaFoundation.StreamSink.ProcessSample(SharpDX.MediaFoundation.Sample)"/></strong> on the media sink.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::llLastTimestampProcessed']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>longlong llLastTimestampProcessed</unmanaged>
|
|
<unmanaged-short>longlong llLastTimestampProcessed</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.LlLastStreamTickReceived">
|
|
<summary>
|
|
<dd> <p>The time stamp of the most recent stream tick. The sink writer updates this value whenever the application calls <strong><see cref="M:SharpDX.MediaFoundation.SinkWriter.SendStreamTick(System.Int32,System.Int64)"/></strong>.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::llLastStreamTickReceived']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>longlong llLastStreamTickReceived</unmanaged>
|
|
<unmanaged-short>longlong llLastStreamTickReceived</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.LlLastSinkSampleRequest">
|
|
<summary>
|
|
<dd> <p>The system time of the most recent sample request from the media sink. The sink writer updates this value whenever it receives an <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.StreamSinkRequestSample"/> event from the media sink. The value is the current system time.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::llLastSinkSampleRequest']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>longlong llLastSinkSampleRequest</unmanaged>
|
|
<unmanaged-short>longlong llLastSinkSampleRequest</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.QwNumSamplesReceived">
|
|
<summary>
|
|
<dd> <p>The number of samples received.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::qwNumSamplesReceived']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned longlong qwNumSamplesReceived</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwNumSamplesReceived</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.QwNumSamplesEncoded">
|
|
<summary>
|
|
<dd> <p>The number of samples encoded.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::qwNumSamplesEncoded']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned longlong qwNumSamplesEncoded</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwNumSamplesEncoded</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.QwNumSamplesProcessed">
|
|
<summary>
|
|
<dd> <p>The number of samples given to the media sink.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::qwNumSamplesProcessed']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned longlong qwNumSamplesProcessed</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwNumSamplesProcessed</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.QwNumStreamTicksReceived">
|
|
<summary>
|
|
<dd> <p>The number of stream ticks received.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::qwNumStreamTicksReceived']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned longlong qwNumStreamTicksReceived</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwNumStreamTicksReceived</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.DwByteCountQueued">
|
|
<summary>
|
|
<dd> <p>The amount of data, in bytes, currently waiting to be processed. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::dwByteCountQueued']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned int dwByteCountQueued</unmanaged>
|
|
<unmanaged-short>unsigned int dwByteCountQueued</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.QwByteCountProcessed">
|
|
<summary>
|
|
<dd> <p>The total amount of data, in bytes, that has been sent to the media sink.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::qwByteCountProcessed']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned longlong qwByteCountProcessed</unmanaged>
|
|
<unmanaged-short>unsigned longlong qwByteCountProcessed</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.DwNumOutstandingSinkSampleRequests">
|
|
<summary>
|
|
<dd> <p>The number of pending sample requests.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::dwNumOutstandingSinkSampleRequests']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned int dwNumOutstandingSinkSampleRequests</unmanaged>
|
|
<unmanaged-short>unsigned int dwNumOutstandingSinkSampleRequests</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.DwAverageSampleRateReceived">
|
|
<summary>
|
|
<dd> <p>The average rate, in media samples per 100-nanoseconds, at which the application sent samples to the sink writer.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::dwAverageSampleRateReceived']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned int dwAverageSampleRateReceived</unmanaged>
|
|
<unmanaged-short>unsigned int dwAverageSampleRateReceived</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.DwAverageSampleRateEncoded">
|
|
<summary>
|
|
<dd> <p>The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the encoder.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::dwAverageSampleRateEncoded']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned int dwAverageSampleRateEncoded</unmanaged>
|
|
<unmanaged-short>unsigned int dwAverageSampleRateEncoded</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.SinkWriterStatistics.DwAverageSampleRateProcessed">
|
|
<summary>
|
|
<dd> <p>The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the media sink.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_SINK_WRITER_STATISTICS::dwAverageSampleRateProcessed']/*"/>
|
|
<msdn-id>dd375769</msdn-id>
|
|
<unmanaged>unsigned int dwAverageSampleRateProcessed</unmanaged>
|
|
<unmanaged-short>unsigned int dwAverageSampleRateProcessed</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.StreamMedium">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='STREAM_MEDIUM']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>STREAM_MEDIUM</unmanaged>
|
|
<unmanaged-short>STREAM_MEDIUM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamMedium.GidMedium">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='STREAM_MEDIUM::gidMedium']/*"/>
|
|
<unmanaged>GUID gidMedium</unmanaged>
|
|
<unmanaged-short>GUID gidMedium</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.StreamMedium.UnMediumInstance">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='STREAM_MEDIUM::unMediumInstance']/*"/>
|
|
<unmanaged>unsigned int unMediumInstance</unmanaged>
|
|
<unmanaged-short>unsigned int unMediumInstance</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TInputStreamInformation">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_INFO']/*"/>
|
|
<unmanaged>MFT_INPUT_STREAM_INFO</unmanaged>
|
|
<unmanaged-short>MFT_INPUT_STREAM_INFO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TInputStreamInformation.HnsMaxLatency">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_INFO::hnsMaxLatency']/*"/>
|
|
<unmanaged>longlong hnsMaxLatency</unmanaged>
|
|
<unmanaged-short>longlong hnsMaxLatency</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TInputStreamInformation.DwFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_INFO::dwFlags']/*"/>
|
|
<unmanaged>unsigned int dwFlags</unmanaged>
|
|
<unmanaged-short>unsigned int dwFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TInputStreamInformation.CbSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_INFO::cbSize']/*"/>
|
|
<unmanaged>unsigned int cbSize</unmanaged>
|
|
<unmanaged-short>unsigned int cbSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TInputStreamInformation.CbMaxLookahead">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_INFO::cbMaxLookahead']/*"/>
|
|
<unmanaged>unsigned int cbMaxLookahead</unmanaged>
|
|
<unmanaged-short>unsigned int cbMaxLookahead</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TInputStreamInformation.CbAlignment">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_INPUT_STREAM_INFO::cbAlignment']/*"/>
|
|
<unmanaged>unsigned int cbAlignment</unmanaged>
|
|
<unmanaged-short>unsigned int cbAlignment</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.ToponodeAttributeUpdate">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Contains private data for the <strong>IDirectXVideoDecoder::Execute</strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>This structure corresponds to parameters of the <strong>IAMVideoAccelerator::Execute</strong> method in DirectX Video Acceleration (DXVA) version 1.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPONODE_ATTRIBUTE_UPDATE']/*"/>
|
|
<msdn-id>ms696173</msdn-id>
|
|
<unmanaged>MFTOPONODE_ATTRIBUTE_UPDATE</unmanaged>
|
|
<unmanaged-short>MFTOPONODE_ATTRIBUTE_UPDATE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeAttributeUpdate.NodeId">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPONODE_ATTRIBUTE_UPDATE::NodeId']/*"/>
|
|
<unmanaged>unsigned longlong NodeId</unmanaged>
|
|
<unmanaged-short>unsigned longlong NodeId</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeAttributeUpdate.GuidAttributeKey">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPONODE_ATTRIBUTE_UPDATE::guidAttributeKey']/*"/>
|
|
<unmanaged>GUID guidAttributeKey</unmanaged>
|
|
<unmanaged-short>GUID guidAttributeKey</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeAttributeUpdate.AttrType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPONODE_ATTRIBUTE_UPDATE::attrType']/*"/>
|
|
<unmanaged>MF_ATTRIBUTE_TYPE attrType</unmanaged>
|
|
<unmanaged-short>MF_ATTRIBUTE_TYPE attrType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeAttributeUpdate.U32">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPONODE_ATTRIBUTE_UPDATE::u32']/*"/>
|
|
<unmanaged>unsigned int u32</unmanaged>
|
|
<unmanaged-short>unsigned int u32</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeAttributeUpdate.U64">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPONODE_ATTRIBUTE_UPDATE::u64']/*"/>
|
|
<unmanaged>unsigned longlong u64</unmanaged>
|
|
<unmanaged-short>unsigned longlong u64</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.ToponodeAttributeUpdate.D">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFTOPONODE_ATTRIBUTE_UPDATE::d']/*"/>
|
|
<unmanaged>double d</unmanaged>
|
|
<unmanaged-short>double d</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TOutputDataBuffer">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Contains information about an output buffer for a Media Foundation transform. This structure is used in the <strong><see cref="M:SharpDX.MediaFoundation.Transform.ProcessOutput(System.Int32,System.Int32,SharpDX.MediaFoundation.TOutputDataBuffer,System.Int32)"/></strong> method.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>You must provide an <strong><see cref="T:SharpDX.MediaFoundation.TOutputDataBuffer"/></strong> structure for each selected output stream.</p><p>MFTs can support two different allocation models for output samples:</p><ul> <li> The MFT allocates the output sample. </li> <li> The client allocates the output sample. </li> </ul><p>To find which model the MFT supports for a given output stream, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputStreamInfo(System.Int32,SharpDX.MediaFoundation.TOutputStreamInformation@)"/></strong> and check the value of <strong>dwFlags</strong>.</p><table> <tr><th>Flag</th><th>Allocation Model</th></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamProvidesSamples"/></td><td>The MFT allocates the output samples for the stream. Set <strong>pSample</strong> to <strong><c>null</c></strong> for this stream.</td></tr> <tr><td><see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamCanProvideSamples"/></td><td>The MFT supports both allocation models.</td></tr> <tr><td>Neither (default)</td><td>The client must allocate the output samples for the stream.</td></tr> </table><p>?</p><p>The behavior of <strong>ProcessOutput</strong> depends on the initial value of <strong>pSample</strong> and the value of the <em>dwFlags</em> parameter in the <strong>ProcessOutput</strong> method.</p><ul> <li> <p>If <strong>pSample</strong> is <strong><c>null</c></strong> and <em>dwFlags</em> contains the <see cref="F:SharpDX.MediaFoundation.MftProcessOutputFlags.MftProcessOutputDiscardWhenNoBuffer"/> flag, the MFT discards the output data.</p> <p>Restriction: This output stream must have the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamDiscardable"/> or <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamLazyRead"/> flag. (To get the flags for the output stream, call the <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputStreamInfo(System.Int32,SharpDX.MediaFoundation.TOutputStreamInformation@)"/></strong> method.)</p> </li> <li> <p>If <strong>pSample</strong> is <strong><c>null</c></strong> and <em>dwFlags</em> does not contain the <see cref="F:SharpDX.MediaFoundation.MftProcessOutputFlags.MftProcessOutputDiscardWhenNoBuffer"/>, the MFT provides a sample for the output data. The MFT sets <strong>pSample</strong> to point to the sample that it provides. The MFT can either allocate a new sample or re-use an input sample.</p> <p>Restriction: This output stream must have the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamProvidesSamples"/> or <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamCanProvideSamples"/> flag.</p> </li> <li> <p>If <strong>pSample</strong> is non-<strong><c>null</c></strong>, the MFT uses the sample provided by the caller.</p> <p>Restriction: This output stream must not have the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamProvidesSamples"/> flag.</p> </li> </ul><p>Any other combinations are invalid and cause <strong>ProcessOutput</strong> to return E_INVALIDARG.</p><p>Each call to <strong>ProcessOutput</strong> can produce zero or more events and up to one sample per output stream.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_DATA_BUFFER']/*"/>
|
|
<msdn-id>ms697247</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_DATA_BUFFER</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_DATA_BUFFER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TOutputDataBuffer.DwStreamID">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_DATA_BUFFER::dwStreamID']/*"/>
|
|
<unmanaged>unsigned int dwStreamID</unmanaged>
|
|
<unmanaged-short>unsigned int dwStreamID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TOutputDataBuffer.PSample">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_DATA_BUFFER::pSample']/*"/>
|
|
<unmanaged>IMFSample* pSample</unmanaged>
|
|
<unmanaged-short>IMFSample pSample</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TOutputDataBuffer.DwStatus">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_DATA_BUFFER::dwStatus']/*"/>
|
|
<unmanaged>unsigned int dwStatus</unmanaged>
|
|
<unmanaged-short>unsigned int dwStatus</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TOutputDataBuffer.PEvents">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_DATA_BUFFER::pEvents']/*"/>
|
|
<unmanaged>IMFCollection* pEvents</unmanaged>
|
|
<unmanaged-short>IMFCollection pEvents</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TOutputStreamInformation">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Contains information about an output stream on a Media Foundation transform (MFT). To get these values, call <strong><see cref="M:SharpDX.MediaFoundation.Transform.GetOutputStreamInfo(System.Int32,SharpDX.MediaFoundation.TOutputStreamInformation@)"/></strong>.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Before the media types are set, the only values that should be considered valid is the <see cref="F:SharpDX.MediaFoundation.MftOutputStreamInformationFlags.MftOutputStreamOptional"/> flag in the <strong>dwFlags</strong> member. This flag indicates that the stream is optional and does not require a media type.</p><p>After you set a media type on all of the input and output streams (not including optional streams), all of the values returned by the <strong>GetOutputStreamInfo</strong> method are valid. They might change if you set different media types.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_INFO']/*"/>
|
|
<msdn-id>ms696974</msdn-id>
|
|
<unmanaged>MFT_OUTPUT_STREAM_INFO</unmanaged>
|
|
<unmanaged-short>MFT_OUTPUT_STREAM_INFO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TOutputStreamInformation.DwFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_INFO::dwFlags']/*"/>
|
|
<unmanaged>unsigned int dwFlags</unmanaged>
|
|
<unmanaged-short>unsigned int dwFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TOutputStreamInformation.CbSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_INFO::cbSize']/*"/>
|
|
<unmanaged>unsigned int cbSize</unmanaged>
|
|
<unmanaged-short>unsigned int cbSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TOutputStreamInformation.CbAlignment">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_OUTPUT_STREAM_INFO::cbAlignment']/*"/>
|
|
<unmanaged>unsigned int cbAlignment</unmanaged>
|
|
<unmanaged-short>unsigned int cbAlignment</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TranscodeSinkInformation">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains information about the audio and video streams for the transcode sink activation object.</p><p>To get the information stored in this structure, call <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.GetSinkInfo(SharpDX.MediaFoundation.TranscodeSinkInformation@)"/></strong>.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>The <strong><see cref="M:SharpDX.MediaFoundation.TranscodeSinkInfoProvider.GetSinkInfo(SharpDX.MediaFoundation.TranscodeSinkInformation@)"/></strong> method assigns <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> references to the <strong>pAudioMediaType</strong> and <strong>pVideoMediaType</strong> members of this structure. The method might set either member to <strong><c>null</c></strong>. If either member is non-<strong><c>null</c></strong> after the method returns, the caller must release the <strong><see cref="T:SharpDX.MediaFoundation.MediaType"/></strong> references.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_SINK_INFO']/*"/>
|
|
<msdn-id>dd388923</msdn-id>
|
|
<unmanaged>MF_TRANSCODE_SINK_INFO</unmanaged>
|
|
<unmanaged-short>MF_TRANSCODE_SINK_INFO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeSinkInformation.DwVideoStreamID">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_SINK_INFO::dwVideoStreamID']/*"/>
|
|
<unmanaged>unsigned int dwVideoStreamID</unmanaged>
|
|
<unmanaged-short>unsigned int dwVideoStreamID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeSinkInformation.PVideoMediaType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_SINK_INFO::pVideoMediaType']/*"/>
|
|
<unmanaged>IMFMediaType* pVideoMediaType</unmanaged>
|
|
<unmanaged-short>IMFMediaType pVideoMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeSinkInformation.DwAudioStreamID">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_SINK_INFO::dwAudioStreamID']/*"/>
|
|
<unmanaged>unsigned int dwAudioStreamID</unmanaged>
|
|
<unmanaged-short>unsigned int dwAudioStreamID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TranscodeSinkInformation.PAudioMediaType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MF_TRANSCODE_SINK_INFO::pAudioMediaType']/*"/>
|
|
<unmanaged>IMFMediaType* pAudioMediaType</unmanaged>
|
|
<unmanaged-short>IMFMediaType pAudioMediaType</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TRegisterTypeInformation">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains media type information for registering a Media Foundation transform (MFT). </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTER_TYPE_INFO']/*"/>
|
|
<msdn-id>ms694919</msdn-id>
|
|
<unmanaged>MFT_REGISTER_TYPE_INFO</unmanaged>
|
|
<unmanaged-short>MFT_REGISTER_TYPE_INFO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TRegisterTypeInformation.GuidMajorType">
|
|
<summary>
|
|
<dd> <p>The major media type. For a list of possible values, see Major Media Types. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTER_TYPE_INFO::guidMajorType']/*"/>
|
|
<msdn-id>ms694919</msdn-id>
|
|
<unmanaged>GUID guidMajorType</unmanaged>
|
|
<unmanaged-short>GUID guidMajorType</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TRegisterTypeInformation.GuidSubtype">
|
|
<summary>
|
|
<dd> <p>The media subtype. For a list of possible values, see the following topics:</p> <ul> <li> Audio Subtype GUIDs </li> <li> Video Subtype GUIDs </li> </ul> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTER_TYPE_INFO::guidSubtype']/*"/>
|
|
<msdn-id>ms694919</msdn-id>
|
|
<unmanaged>GUID guidSubtype</unmanaged>
|
|
<unmanaged-short>GUID guidSubtype</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.TRegistrationInformation">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p>Contains parameters for the <strong><see cref="M:SharpDX.MediaFoundation.LocalMFTRegistration.RegisterMFTs(SharpDX.MediaFoundation.TRegistrationInformation[],System.Int32)"/></strong> method.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTRATION_INFO']/*"/>
|
|
<msdn-id>dd388673</msdn-id>
|
|
<unmanaged>MFT_REGISTRATION_INFO</unmanaged>
|
|
<unmanaged-short>MFT_REGISTRATION_INFO</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TRegistrationInformation.Clsid">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTRATION_INFO::clsid']/*"/>
|
|
<unmanaged>GUID clsid</unmanaged>
|
|
<unmanaged-short>GUID clsid</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TRegistrationInformation.GuidCategory">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTRATION_INFO::guidCategory']/*"/>
|
|
<unmanaged>GUID guidCategory</unmanaged>
|
|
<unmanaged-short>GUID guidCategory</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TRegistrationInformation.UiFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTRATION_INFO::uiFlags']/*"/>
|
|
<unmanaged>unsigned int uiFlags</unmanaged>
|
|
<unmanaged-short>unsigned int uiFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TRegistrationInformation.PszName">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTRATION_INFO::pszName']/*"/>
|
|
<unmanaged>const wchar_t* pszName</unmanaged>
|
|
<unmanaged-short>wchar_t pszName</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TRegistrationInformation.CInTypes">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTRATION_INFO::cInTypes']/*"/>
|
|
<unmanaged>unsigned int cInTypes</unmanaged>
|
|
<unmanaged-short>unsigned int cInTypes</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TRegistrationInformation.PInTypes">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTRATION_INFO::pInTypes']/*"/>
|
|
<unmanaged>MFT_REGISTER_TYPE_INFO* pInTypes</unmanaged>
|
|
<unmanaged-short>MFT_REGISTER_TYPE_INFO pInTypes</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TRegistrationInformation.COutTypes">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTRATION_INFO::cOutTypes']/*"/>
|
|
<unmanaged>unsigned int cOutTypes</unmanaged>
|
|
<unmanaged-short>unsigned int cOutTypes</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.TRegistrationInformation.POutTypes">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFT_REGISTRATION_INFO::pOutTypes']/*"/>
|
|
<unmanaged>MFT_REGISTER_TYPE_INFO* pOutTypes</unmanaged>
|
|
<unmanaged-short>MFT_REGISTER_TYPE_INFO pOutTypes</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoArea">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> Specifies a rectangular area within a video frame. </p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoArea']/*"/>
|
|
<msdn-id>ms703850</msdn-id>
|
|
<unmanaged>MFVideoArea</unmanaged>
|
|
<unmanaged-short>MFVideoArea</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoArea.OffsetX">
|
|
<summary>
|
|
<dd> <p> An <strong><see cref="T:SharpDX.MediaFoundation.Offset"/></strong> structure that contains the x-coordinate of the upper-left corner of the rectangle. This coordinate might have a fractional value. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoArea::OffsetX']/*"/>
|
|
<msdn-id>ms703850</msdn-id>
|
|
<unmanaged>MFOffset OffsetX</unmanaged>
|
|
<unmanaged-short>MFOffset OffsetX</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoArea.OffsetY">
|
|
<summary>
|
|
<dd> <p> An <strong><see cref="T:SharpDX.MediaFoundation.Offset"/></strong> structure that contains the y-coordinate of the upper-left corner of the rectangle. This coordinate might have a fractional value. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoArea::OffsetY']/*"/>
|
|
<msdn-id>ms703850</msdn-id>
|
|
<unmanaged>MFOffset OffsetY</unmanaged>
|
|
<unmanaged-short>MFOffset OffsetY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoArea.Area">
|
|
<summary>
|
|
<dd> <p> A <strong><see cref="T:SharpDX.DrawingSize"/></strong> structure that contains the width and height of the rectangle. </p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoArea::Area']/*"/>
|
|
<msdn-id>ms703850</msdn-id>
|
|
<unmanaged>SIZE Area</unmanaged>
|
|
<unmanaged-short>SIZE Area</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoCompressedInfo">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Describes a video format.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Applications should avoid using this structure. Instead, it is recommended that applications use attributes to describe the video format. For a list of media type attributes, see Media Type Attributes. With attributes, you can set just the format information that you know, which is easier (and more likely to be accurate) than trying to fill in complete format information for the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure.</p><p>To initialize a media type object from an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.InitMediaTypeFromMFVideoFormat(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.Videoformat[],System.Int32)"/></strong>.</p><p>You can use the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure as the format block for a DirectShow media type. Set the format <see cref="T:System.Guid"/> to FORMAT_MFVideoFormat.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoCompressedInfo']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFVideoCompressedInfo</unmanaged>
|
|
<unmanaged-short>MFVideoCompressedInfo</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoCompressedInfo.AvgBitrate">
|
|
<summary>
|
|
<dd> <p>Size of the structure, in bytes. This value includes the size of the palette entries that may appear after the <strong>surfaceInfo</strong> member.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoCompressedInfo::AvgBitrate']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>longlong AvgBitrate</unmanaged>
|
|
<unmanaged-short>longlong AvgBitrate</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoCompressedInfo.AvgBitErrorRate">
|
|
<summary>
|
|
<dd> <p> <strong><see cref="T:SharpDX.MediaFoundation.VideoInfo"/></strong> structure. This structure contains information that applies to both compressed and uncompressed formats.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoCompressedInfo::AvgBitErrorRate']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>longlong AvgBitErrorRate</unmanaged>
|
|
<unmanaged-short>longlong AvgBitErrorRate</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoCompressedInfo.MaxKeyFrameSpacing">
|
|
<summary>
|
|
<dd> <p>Video subtype. See Video Subtype GUIDs.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoCompressedInfo::MaxKeyFrameSpacing']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>unsigned int MaxKeyFrameSpacing</unmanaged>
|
|
<unmanaged-short>unsigned int MaxKeyFrameSpacing</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.Videoformat">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Describes a video format.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Applications should avoid using this structure. Instead, it is recommended that applications use attributes to describe the video format. For a list of media type attributes, see Media Type Attributes. With attributes, you can set just the format information that you know, which is easier (and more likely to be accurate) than trying to fill in complete format information for the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure.</p><p>To initialize a media type object from an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.InitMediaTypeFromMFVideoFormat(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.Videoformat[],System.Int32)"/></strong>.</p><p>You can use the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure as the format block for a DirectShow media type. Set the format <see cref="T:System.Guid"/> to FORMAT_MFVideoFormat.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVIDEOFORMAT']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFVIDEOFORMAT</unmanaged>
|
|
<unmanaged-short>MFVIDEOFORMAT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Videoformat.DwSize">
|
|
<summary>
|
|
<dd> <p>Size of the structure, in bytes. This value includes the size of the palette entries that may appear after the <strong>surfaceInfo</strong> member.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVIDEOFORMAT::dwSize']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>unsigned int dwSize</unmanaged>
|
|
<unmanaged-short>unsigned int dwSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Videoformat.VideoInfo">
|
|
<summary>
|
|
<dd> <p> <strong><see cref="T:SharpDX.MediaFoundation.VideoInfo"/></strong> structure. This structure contains information that applies to both compressed and uncompressed formats.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVIDEOFORMAT::videoInfo']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFVideoInfo videoInfo</unmanaged>
|
|
<unmanaged-short>MFVideoInfo videoInfo</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Videoformat.GuidFormat">
|
|
<summary>
|
|
<dd> <p>Video subtype. See Video Subtype GUIDs.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVIDEOFORMAT::guidFormat']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>GUID guidFormat</unmanaged>
|
|
<unmanaged-short>GUID guidFormat</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Videoformat.CompressedInfo">
|
|
<summary>
|
|
<dd> <p> <strong><see cref="T:SharpDX.MediaFoundation.VideoCompressedInfo"/></strong> structure. This structure contains information that applies only to compressed formats.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVIDEOFORMAT::compressedInfo']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFVideoCompressedInfo compressedInfo</unmanaged>
|
|
<unmanaged-short>MFVideoCompressedInfo compressedInfo</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.Videoformat.SurfaceInfo">
|
|
<summary>
|
|
<dd> <p> <strong><see cref="T:SharpDX.MediaFoundation.VideoSurfaceInfo"/></strong> structure. This structure contains information that applies only to uncompressed formats.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVIDEOFORMAT::surfaceInfo']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFVideoSurfaceInfo surfaceInfo</unmanaged>
|
|
<unmanaged-short>MFVideoSurfaceInfo surfaceInfo</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoInfo">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Describes a video format.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Applications should avoid using this structure. Instead, it is recommended that applications use attributes to describe the video format. For a list of media type attributes, see Media Type Attributes. With attributes, you can set just the format information that you know, which is easier (and more likely to be accurate) than trying to fill in complete format information for the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure.</p><p>To initialize a media type object from an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.InitMediaTypeFromMFVideoFormat(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.Videoformat[],System.Int32)"/></strong>.</p><p>You can use the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure as the format block for a DirectShow media type. Set the format <see cref="T:System.Guid"/> to FORMAT_MFVideoFormat.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFVideoInfo</unmanaged>
|
|
<unmanaged-short>MFVideoInfo</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.DwWidth">
|
|
<summary>
|
|
<dd> <p>Size of the structure, in bytes. This value includes the size of the palette entries that may appear after the <strong>surfaceInfo</strong> member.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::dwWidth']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>unsigned int dwWidth</unmanaged>
|
|
<unmanaged-short>unsigned int dwWidth</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.DwHeight">
|
|
<summary>
|
|
<dd> <p> <strong><see cref="T:SharpDX.MediaFoundation.VideoInfo"/></strong> structure. This structure contains information that applies to both compressed and uncompressed formats.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::dwHeight']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>unsigned int dwHeight</unmanaged>
|
|
<unmanaged-short>unsigned int dwHeight</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.PixelAspectRatio">
|
|
<summary>
|
|
<dd> <p>Video subtype. See Video Subtype GUIDs.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::PixelAspectRatio']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFRatio PixelAspectRatio</unmanaged>
|
|
<unmanaged-short>MFRatio PixelAspectRatio</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.SourceChromaSubsampling">
|
|
<summary>
|
|
<dd> <p> <strong><see cref="T:SharpDX.MediaFoundation.VideoCompressedInfo"/></strong> structure. This structure contains information that applies only to compressed formats.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::SourceChromaSubsampling']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFVideoChromaSubsampling SourceChromaSubsampling</unmanaged>
|
|
<unmanaged-short>MFVideoChromaSubsampling SourceChromaSubsampling</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.InterlaceMode">
|
|
<summary>
|
|
<dd> <p> <strong><see cref="T:SharpDX.MediaFoundation.VideoSurfaceInfo"/></strong> structure. This structure contains information that applies only to uncompressed formats.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::InterlaceMode']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFVideoInterlaceMode InterlaceMode</unmanaged>
|
|
<unmanaged-short>MFVideoInterlaceMode InterlaceMode</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.TransferFunction">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::TransferFunction']/*"/>
|
|
<unmanaged>MFVideoTransferFunction TransferFunction</unmanaged>
|
|
<unmanaged-short>MFVideoTransferFunction TransferFunction</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.ColorPrimaries">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::ColorPrimaries']/*"/>
|
|
<unmanaged>MFVideoPrimaries ColorPrimaries</unmanaged>
|
|
<unmanaged-short>MFVideoPrimaries ColorPrimaries</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.TransferMatrix">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::TransferMatrix']/*"/>
|
|
<unmanaged>MFVideoTransferMatrix TransferMatrix</unmanaged>
|
|
<unmanaged-short>MFVideoTransferMatrix TransferMatrix</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.SourceLighting">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::SourceLighting']/*"/>
|
|
<unmanaged>MFVideoLighting SourceLighting</unmanaged>
|
|
<unmanaged-short>MFVideoLighting SourceLighting</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.FramesPerSecond">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::FramesPerSecond']/*"/>
|
|
<unmanaged>MFRatio FramesPerSecond</unmanaged>
|
|
<unmanaged-short>MFRatio FramesPerSecond</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.NominalRange">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::NominalRange']/*"/>
|
|
<unmanaged>MFNominalRange NominalRange</unmanaged>
|
|
<unmanaged-short>MFNominalRange NominalRange</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.GeometricAperture">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::GeometricAperture']/*"/>
|
|
<unmanaged>MFVideoArea GeometricAperture</unmanaged>
|
|
<unmanaged-short>MFVideoArea GeometricAperture</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.MinimumDisplayAperture">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::MinimumDisplayAperture']/*"/>
|
|
<unmanaged>MFVideoArea MinimumDisplayAperture</unmanaged>
|
|
<unmanaged-short>MFVideoArea MinimumDisplayAperture</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.PanScanAperture">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::PanScanAperture']/*"/>
|
|
<unmanaged>MFVideoArea PanScanAperture</unmanaged>
|
|
<unmanaged-short>MFVideoArea PanScanAperture</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoInfo.VideoFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoInfo::VideoFlags']/*"/>
|
|
<unmanaged>unsigned longlong VideoFlags</unmanaged>
|
|
<unmanaged-short>unsigned longlong VideoFlags</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoNormalizedRect">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p> </p><p>Defines a normalized rectangle, which is used to specify sub-rectangles in a video rectangle. When a rectangle N is <em>normalized</em> relative to some other rectangle R, it means the following:</p><ul> <li> <p>The coordinate (0.0, 0.0) on N is mapped to the upper-left corner of R.</p> </li> <li> <p>The coordinate (1.0, 1.0) on N is mapped to the lower-right corner of R.</p> </li> </ul><p>Any coordinates of N that fall outside the range [0...1] are mapped to positions outside the rectangle R. A normalized rectangle can be used to specify a region within a video rectangle without knowing the resolution or even the aspect ratio of the video. For example, the upper-left quadrant is defined as {0.0, 0.0, 0.5, 0.5}.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoNormalizedRect']/*"/>
|
|
<msdn-id>ms703049</msdn-id>
|
|
<unmanaged>MFVideoNormalizedRect</unmanaged>
|
|
<unmanaged-short>MFVideoNormalizedRect</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoNormalizedRect.Left">
|
|
<summary>
|
|
<dd> <p>X-coordinate of the upper-left corner of the rectangle.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoNormalizedRect::left']/*"/>
|
|
<msdn-id>ms703049</msdn-id>
|
|
<unmanaged>float left</unmanaged>
|
|
<unmanaged-short>float left</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoNormalizedRect.Top">
|
|
<summary>
|
|
<dd> <p>Y-coordinate of the upper-left corner of the rectangle.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoNormalizedRect::top']/*"/>
|
|
<msdn-id>ms703049</msdn-id>
|
|
<unmanaged>float top</unmanaged>
|
|
<unmanaged-short>float top</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoNormalizedRect.Right">
|
|
<summary>
|
|
<dd> <p>X-coordinate of the lower-right corner of the rectangle.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoNormalizedRect::right']/*"/>
|
|
<msdn-id>ms703049</msdn-id>
|
|
<unmanaged>float right</unmanaged>
|
|
<unmanaged-short>float right</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoNormalizedRect.Bottom">
|
|
<summary>
|
|
<dd> <p>Y-coordinate of the lower-right corner of the rectangle.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoNormalizedRect::bottom']/*"/>
|
|
<msdn-id>ms703049</msdn-id>
|
|
<unmanaged>float bottom</unmanaged>
|
|
<unmanaged-short>float bottom</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.VideoSurfaceInfo">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps only</p><p> </p><p>Describes a video format.</p>
|
|
</summary>
|
|
<remarks>
|
|
<p>Applications should avoid using this structure. Instead, it is recommended that applications use attributes to describe the video format. For a list of media type attributes, see Media Type Attributes. With attributes, you can set just the format information that you know, which is easier (and more likely to be accurate) than trying to fill in complete format information for the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure.</p><p>To initialize a media type object from an <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.InitMediaTypeFromMFVideoFormat(SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.Videoformat[],System.Int32)"/></strong>.</p><p>You can use the <strong><see cref="T:SharpDX.MediaFoundation.Videoformat"/></strong> structure as the format block for a DirectShow media type. Set the format <see cref="T:System.Guid"/> to FORMAT_MFVideoFormat.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoSurfaceInfo']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFVideoSurfaceInfo</unmanaged>
|
|
<unmanaged-short>MFVideoSurfaceInfo</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoSurfaceInfo.Format">
|
|
<summary>
|
|
<dd> <p>Size of the structure, in bytes. This value includes the size of the palette entries that may appear after the <strong>surfaceInfo</strong> member.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoSurfaceInfo::Format']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>unsigned int Format</unmanaged>
|
|
<unmanaged-short>unsigned int Format</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.MediaFoundation.VideoSurfaceInfo.PaletteEntries">
|
|
<summary>
|
|
<dd> <p> <strong><see cref="T:SharpDX.MediaFoundation.VideoInfo"/></strong> structure. This structure contains information that applies to both compressed and uncompressed formats.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoSurfaceInfo::PaletteEntries']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>unsigned int PaletteEntries</unmanaged>
|
|
<unmanaged-short>unsigned int PaletteEntries</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.VideoSurfaceInfo.Palette">
|
|
<summary>
|
|
<dd> <p>Video subtype. See Video Subtype GUIDs.</p> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoSurfaceInfo::Palette']/*"/>
|
|
<msdn-id>aa473808</msdn-id>
|
|
<unmanaged>MFPaletteEntry Palette[1]</unmanaged>
|
|
<unmanaged-short>MFPaletteEntry Palette</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaAttributeKey">
|
|
<summary>
|
|
Associate an attribute key with a type used to retreive keys from a <see cref="T:SharpDX.MediaFoundation.MediaAttributes"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributeKey.#ctor(System.Guid,System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaAttributeKey"/> struct.
|
|
</summary>
|
|
<param name="guid">The GUID.</param>
|
|
<param name="type">The type.</param>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaAttributeKey.Guid">
|
|
<summary>
|
|
Gets or sets the GUID.
|
|
</summary>
|
|
<value>
|
|
The GUID.
|
|
</value>
|
|
</member>
|
|
<member name="P:SharpDX.MediaFoundation.MediaAttributeKey.Type">
|
|
<summary>
|
|
Gets or sets the type.
|
|
</summary>
|
|
<value>
|
|
The type.
|
|
</value>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.MediaAttributeKey`1">
|
|
<summary>
|
|
Generic version of <see cref="T:SharpDX.MediaFoundation.MediaAttributeKey"/>
|
|
</summary>
|
|
<typeparam name="T">Type of the value of this key</typeparam>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributeKey`1.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaAttributeKey`1"/> class.
|
|
</summary>
|
|
<param name="guid">The GUID.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaAttributeKey`1.#ctor(System.Guid)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaAttributeKey`1"/> class.
|
|
</summary>
|
|
<param name="guid">The GUID.</param>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaManager.Startup(System.Boolean)">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Initializes Microsoft Media Foundation.</p>
|
|
</summary>
|
|
<param name="useLightVersion">If true, do not initialize the sockets library, else full initialization. Default is false</param>
|
|
<msdn-id>ms702238</msdn-id>
|
|
<unmanaged>HRESULT MFStartup([In] unsigned int Version,[In] unsigned int dwFlags)</unmanaged>
|
|
<unmanaged-short>MFStartup</unmanaged-short>
|
|
<remarks>
|
|
<p> An application must call this function before using Media Foundation. Before your application quits, call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> once for every previous call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. </p><p> Do not call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong> or <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Shutdown"/></strong> from work queue threads. For more information about work queues, see Work Queues. </p><p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul>
|
|
<li>Windows?XP with Service Pack?2 (SP2) and later.</li>
|
|
<li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li>
|
|
</ul>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:SharpDX.MediaFoundation.MediaManager.Shutdown">
|
|
<summary>
|
|
<p><strong>Applies to: </strong>desktop apps | Metro style apps</p><p>Shuts down the Microsoft Media Foundation platform. Call this function once for every call to <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,System.Int32)"/></strong>. Do not call this function from work queue threads.</p>
|
|
</summary>
|
|
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result"/></strong> error code.</p></returns>
|
|
<remarks>
|
|
<p>This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:</p><ul> <li>Windows?XP with Service Pack?2 (SP2) and later.</li> <li>Windows?XP Media Center Edition?2005 with KB900325 (Windows?XP Media Center Edition?2005) and KB925766 (October 2006 Update Rollup for Windows?XP Media Center Edition) installed.</li> </ul>
|
|
</remarks>
|
|
<msdn-id>ms694273</msdn-id>
|
|
<unmanaged>HRESULT MFShutdown()</unmanaged>
|
|
<unmanaged-short>MFShutdown</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.MediaFoundation.NamespaceDoc">
|
|
<summary>
|
|
The <see cref="N:SharpDX.MediaFoundation"/> namespace provides a managed MediaFoundation API.
|
|
</summary>
|
|
<msdn-id></msdn-id>
|
|
<unmanaged>MediaFoundation</unmanaged>
|
|
<unmanaged-short>MediaFoundation</unmanaged-short>
|
|
</member>
|
|
</members>
|
|
</doc>
|