Skip to content
Snippets Groups Projects
SharpDX.MediaFoundation.xml 5.17 MiB
Newer Older
SCHAAL CESAR's avatar
SCHAAL CESAR committed
53001 53002 53003 53004 53005 53006 53007 53008 53009 53010 53011 53012 53013 53014 53015 53016 53017 53018 53019 53020 53021 53022 53023 53024 53025 53026 53027 53028 53029 53030 53031 53032 53033 53034 53035 53036 53037 53038 53039 53040 53041 53042 53043 53044 53045 53046 53047 53048 53049 53050 53051 53052 53053 53054 53055 53056 53057 53058 53059 53060 53061 53062 53063 53064 53065 53066 53067 53068 53069 53070 53071 53072 53073 53074 53075 53076 53077 53078 53079 53080 53081 53082 53083 53084 53085 53086 53087 53088 53089 53090 53091 53092 53093 53094 53095 53096 53097 53098 53099 53100 53101 53102 53103 53104 53105 53106 53107 53108 53109 53110 53111 53112 53113 53114 53115 53116 53117 53118 53119 53120 53121 53122 53123 53124 53125 53126 53127 53128 53129 53130 53131 53132 53133 53134 53135 53136 53137 53138 53139 53140 53141 53142 53143 53144 53145 53146 53147 53148 53149 53150 53151 53152 53153 53154 53155 53156 53157 53158 53159 53160 53161 53162 53163 53164 53165 53166 53167 53168 53169 53170 53171 53172 53173 53174 53175 53176 53177 53178 53179 53180 53181 53182 53183 53184 53185 53186 53187 53188 53189 53190 53191 53192 53193 53194 53195 53196 53197 53198 53199 53200 53201 53202 53203 53204 53205 53206 53207 53208 53209 53210 53211 53212 53213 53214 53215 53216 53217 53218 53219 53220 53221 53222 53223 53224 53225 53226 53227 53228 53229 53230 53231 53232 53233 53234 53235 53236 53237 53238 53239 53240 53241 53242 53243 53244 53245 53246 53247 53248 53249 53250 53251 53252 53253 53254 53255 53256 53257 53258 53259 53260 53261 53262 53263 53264 53265 53266 53267 53268 53269 53270 53271 53272 53273 53274 53275 53276 53277 53278 53279 53280 53281 53282 53283 53284 53285 53286 53287 53288 53289 53290 53291 53292 53293 53294 53295 53296 53297 53298 53299 53300 53301 53302 53303 53304 53305 53306 53307 53308 53309 53310 53311 53312 53313 53314 53315 53316
            </summary>	
            <!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoSurfaceInfo::PaletteEntries']/*" />	
            <msdn-id>aa473817</msdn-id>	
            <unmanaged>unsigned int PaletteEntries</unmanaged>	
            <unmanaged-short>unsigned int PaletteEntries</unmanaged-short>	
        </member>
        <member name="P:SharpDX.MediaFoundation.VideoSurfaceInfo.Palette">
            <summary>	
            No documentation.	
            </summary>	
            <!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MFVideoSurfaceInfo::Palette']/*" />	
            <msdn-id>aa473817</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 retrieve 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 attribute GUID.</param>
            <param name="type">The attribute type.</param>
        </member>
        <member name="M:SharpDX.MediaFoundation.MediaAttributeKey.#ctor(System.Guid,System.Type,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaAttributeKey"/> struct.
            </summary>
            <param name="guid">The attribute GUID.</param>
            <param name="type">The attribute type.</param>
            <param name="name">The attribute name, useful for debugging.</param>
        </member>
        <member name="P:SharpDX.MediaFoundation.MediaAttributeKey.Guid">
            <summary>
            Gets  the attribute GUID.
            </summary>
            <value>
            The attribute GUID.
            </value>
        </member>
        <member name="P:SharpDX.MediaFoundation.MediaAttributeKey.Type">
            <summary>
            Gets  the attribute type.
            </summary>
            <value>
            The attribute type.
            </value>
        </member>
        <member name="P:SharpDX.MediaFoundation.MediaAttributeKey.Name">
            <summary>
            Gets the attribute name.
            </summary>
        </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 attribute GUID.</param>
        </member>
        <member name="M:SharpDX.MediaFoundation.MediaAttributeKey`1.#ctor(System.String,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaAttributeKey`1"/> class.
            </summary>
            <param name="guid">The GUID.</param>
            <param name="name">The attribute name, useful for debugging.</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.MediaAttributeKey`1.#ctor(System.Guid,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaAttributeKey`1"/> class.
            </summary>
            <param name="guid">The GUID.</param>
            /// <param name="name">The attribute name, useful for debugging.</param>
        </member>
        <member name="T:SharpDX.MediaFoundation.MediaEngineNotifyDelegate">
            <summary>
            Delegate MediaEngineNotifyDelegate {CC2D43FA-BBC4-448A-9D0B-7B57ADF2655C}
            </summary>
            <param name="mediaEvent">The media event.</param>
            <param name="param1">The param1.</param>
            <param name="param2">The param2.</param>
        </member>
        <member name="T:SharpDX.MediaFoundation.MediaEngineAttributes">
            <summary>
            Attributes used when instantiating <see cref="T:SharpDX.MediaFoundation.MediaEngine"/> class.
            </summary>
        </member>
        <member name="M:SharpDX.MediaFoundation.MediaEngineAttributes.#ctor(System.IntPtr)">
            <summary>
            Initializes a new instance of <see cref="T:SharpDX.MediaFoundation.MediaEngineAttributes"/> class.
            </summary>
            <param name="nativePtr">A native COM pointer to a MediaEngineAttributes</param>
        </member>
        <member name="M:SharpDX.MediaFoundation.MediaEngineAttributes.#ctor(System.Int32)">
            <summary>
            Initializes a new instance of <see cref="T:SharpDX.MediaFoundation.MediaEngineAttributes"/> class.
            </summary>
            <param name="initialSizeInBytes">Size of the data to allocate</param>
        </member>
        <member name="T:SharpDX.MediaFoundation.MediaEngineNotifyShadow">
            <summary>
            Internal MediaEngineNotify Callback
            </summary>
        </member>
        <member name="M:SharpDX.MediaFoundation.MediaEngineNotifyShadow.ToIntPtr(SharpDX.MediaFoundation.MediaEngineNotify)">
            <summary>
            Return a pointer to the unmanaged version of this callback.
            </summary>
            <param name="callback">The callback.</param>
            <returns>A pointer to a shadow c++ callback</returns>
        </member>
        <member name="T:SharpDX.MediaFoundation.MediaEngineNotifyShadow.MediaEngineNotifyVtbl.EventNotifyDelegate">
            <unmanaged>HRESULT IMFMediaEngineNotify::EventNotify([In] unsigned int event,[In] ULONG_PTR param1,[In] unsigned int param2)</unmanaged>	
        </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.MediaSessionCallback">
            <summary>
            Specialized callback for <see cref="T:SharpDX.MediaFoundation.MediaSession"/>. This callback automatically starts the callback on the session,
            handles <see cref="M:SharpDX.MediaFoundation.MediaEventGenerator.EndGetEvent(SharpDX.MediaFoundation.AsyncResult)"/> on invoke, dispatch the asynchronous event to an external action to
            be implemented by the client and stops the callback when the event <see cref="F:SharpDX.MediaFoundation.MediaEventTypes.SessionClosed"/> is received.
            </summary>
        </member>
        <member name="M:SharpDX.MediaFoundation.MediaSessionCallback.#ctor(SharpDX.MediaFoundation.MediaSession,System.Action{SharpDX.MediaFoundation.MediaEvent})">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.MediaSessionCallback"/> class.
            </summary>
            <param name="session">The session.</param>
            <param name="eventCallback">The event callback. The object <see cref="T:SharpDX.MediaFoundation.MediaEvent"/> must be disposed by the callback when finished with it.</param>
            <exception cref="T:System.ArgumentNullException">session or eventCallback</exception>
        </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>
        <member name="T:SharpDX.MediaFoundation.OPM.NamespaceDoc">
            <summary>
            The <see cref="N:SharpDX.MediaFoundation.OPM"/> namespace provides a managed MediaFoundation for OPM API.
            </summary>
            <msdn-id></msdn-id>
            <unmanaged>MediaFoundation</unmanaged>	
            <unmanaged-short>MediaFoundation</unmanaged-short>	
        </member>
        <member name="T:SharpDX.MediaFoundation.ResourceCharacteristics">
            <summary>
            Resource characteristics returned by <see cref="P:SharpDX.MediaFoundation.MediaEngineEx.ResourceCharacteristics"/>.
            </summary>
            <msdn-id>hh447939</msdn-id>	
            <unmanaged>HRESULT IMFMediaEngineEx::GetResourceCharacteristics([Out] unsigned int* pCharacteristics)</unmanaged>	
            <unmanaged-short>IMFMediaEngineEx::GetResourceCharacteristics</unmanaged-short>	
        </member>
        <member name="F:SharpDX.MediaFoundation.ResourceCharacteristics.None">
            <summary>
            None flag.
            </summary>
        </member>
        <member name="F:SharpDX.MediaFoundation.ResourceCharacteristics.LiveSource">
            <summary>
            The media resource represents a live data source, such as a video camera. If playback is stopped and then restarted, there will be a gap in the content.
            </summary>
        </member>
        <member name="F:SharpDX.MediaFoundation.ResourceCharacteristics.CanSeek">
            <summary>
            The media resource supports seeking. To get the seekable range, call IMFMediaEngine::GetSeekable.
            </summary>
        </member>
        <member name="F:SharpDX.MediaFoundation.ResourceCharacteristics.CanPause">
            <summary>
            The media resource can be paused.
            </summary>
        </member>
        <member name="F:SharpDX.MediaFoundation.ResourceCharacteristics.LongTimeToSeek">
            <summary>
            Seeking this resource can take a long time. For example, it might download through HTTP.
            </summary>
        </member>
        <member name="M:SharpDX.MediaFoundation.SampleGrabberSinkCallbackShadow.ToIntPtr(SharpDX.MediaFoundation.SampleGrabberSinkCallback)">
            <summary>
            Return a pointer to the unmanaged version of this callback.
            </summary>
            <param name="callback">The callback.</param>
            <returns>A pointer to a shadow c++ callback</returns>
        </member>
        <member name="T:SharpDX.MediaFoundation.SampleGrabberSinkCallbackShadow.SampleGrabberSinkCallbackVtbl.PresentationClockDelegate">
            <unmanaged>HRESULT IMFSampleGrabberSinkCallback::OnSetPresentationClock([in] IMFPresentationClock *pPresentationClock);</unmanaged>	
        </member>
        <member name="T:SharpDX.MediaFoundation.SampleGrabberSinkCallbackShadow.SampleGrabberSinkCallbackVtbl.OnProcessSampleDelegate">
            <unmanaged>HRESULT OnProcessSample([in] REFGUID guidMajorMediaType, [in] DWORD dwSampleFlags, [in] LONGLONG llSampleTime, [in] LONGLONG llSampleDuration, [in] const BYTE *pSampleBuffer, [in] DWORD dwSampleSize);</unmanaged>	
        </member>
        <member name="T:SharpDX.MediaFoundation.SampleGrabberSinkCallbackShadow.SampleGrabberSinkCallbackVtbl.ShutdownDelegate">
            <unmanaged>HRESULT IMFSampleGrabberSinkCallback::OnShutdown();</unmanaged>
        </member>
        <member name="M:SharpDX.MediaFoundation.SampleGrabberSinkCallback2Shadow.ToIntPtr(SharpDX.MediaFoundation.SampleGrabberSinkCallback2)">
            <summary>
            Return a pointer to the unmanaged version of this callback.
            </summary>
            <param name="callback">The callback.</param>
            <returns>A pointer to a shadow c++ callback</returns>
        </member>
        <!-- Badly formed XML comment ignored for member "T:SharpDX.MediaFoundation.SampleGrabberSinkCallback2Shadow.SampleGrabberSinkCallback2Vtbl.ProcessSampleExDelegate" -->
        <member name="M:SharpDX.MediaFoundation.VideoPresenterShadow.ToIntPtr(SharpDX.MediaFoundation.VideoPresenter)">
            <summary>
            Return a pointer to the unmanaged version of this callback.
            </summary>
            <param name="callback">The callback.</param>
            <returns>A pointer to a shadow c++ callback</returns>
        </member>
        <member name="T:SharpDX.MediaFoundation.VideoPresenterShadow.VideoPresenterVtbl.ProcessMessageDelegate">
            <unmanaged>HRESULT IMFVideoPresenter::ProcessMessage([In] MFVP_MESSAGE_TYPE eMessage,[In] ULONG_PTR ulParam)</unmanaged>
        </member>
        <member name="T:SharpDX.MediaFoundation.VideoPresenterShadow.VideoPresenterVtbl.GetMediaTypeDelegate">
            <unmanaged>HRESULT GetCurrentMediaType([out] IMFVideoMediaType **ppMediaType)</unmanaged>
        </member>
        <member name="T:SharpDX.MediaFoundation.WorkQueueId">
            <summary>
            A Work Queue Identifier
            </summary>
            <msdn-id>ms703102</msdn-id>	
            <unmanaged>Work Queue Identifiers</unmanaged>	
            <unmanaged-short>Work Queue Identifiers</unmanaged-short>	
        </member>
        <member name="F:SharpDX.MediaFoundation.WorkQueueId.Standard">
            <summary>
            The default queue associated to the <see cref="F:SharpDX.MediaFoundation.WorkQueueType.Standard"/>.
            </summary>
        </member>
        <member name="F:SharpDX.MediaFoundation.WorkQueueId.Id">
            <summary>
            The identifier.
            </summary>
        </member>
        <member name="M:SharpDX.MediaFoundation.WorkQueueId.#ctor(System.Int32)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.WorkQueueId"/> struct.
            </summary>
            <param name="id">The id.</param>
        </member>
        <member name="M:SharpDX.MediaFoundation.WorkQueueId.#ctor(SharpDX.MediaFoundation.WorkQueueType)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.WorkQueueId"/> struct.
            </summary>
            <param name="id">The id.</param>
        </member>
        <member name="M:SharpDX.MediaFoundation.WorkQueueId.op_Implicit(System.Int32)~SharpDX.MediaFoundation.WorkQueueId">
            <summary>
            Performs an implicit conversion from <see cref="T:System.Int32"/> to <see cref="T:SharpDX.MediaFoundation.WorkQueueId"/>.
            </summary>
            <param name="id">The id.</param>
            <returns>The result of the conversion.</returns>
        </member>
        <member name="M:SharpDX.MediaFoundation.WorkQueueId.op_Implicit(SharpDX.MediaFoundation.WorkQueueType)~SharpDX.MediaFoundation.WorkQueueId">
            <summary>
            Performs an implicit conversion from <see cref="T:SharpDX.MediaFoundation.WorkQueueType"/> to <see cref="T:SharpDX.MediaFoundation.WorkQueueId"/>.
            </summary>
            <param name="type">The type.</param>
            <returns>The result of the conversion.</returns>
        </member>
        <member name="M:SharpDX.MediaFoundation.WorkQueueId.op_Explicit(SharpDX.MediaFoundation.WorkQueueId)~System.Int32">
            <summary>
            Performs an explicit conversion from <see cref="T:SharpDX.MediaFoundation.WorkQueueId"/> to <see cref="T:System.Int32"/>.
            </summary>
            <param name="workQueueId">The work queue Id.</param>
            <returns>The result of the conversion.</returns>
        </member>
        <member name="M:SharpDX.MediaFoundation.WorkQueueId.op_Explicit(SharpDX.MediaFoundation.WorkQueueId)~SharpDX.MediaFoundation.WorkQueueType">
            <summary>
            Performs an explicit conversion from <see cref="T:SharpDX.MediaFoundation.WorkQueueId"/> to <see cref="T:SharpDX.MediaFoundation.WorkQueueType"/>.
            </summary>
            <param name="workQueueId">The work queue Id.</param>
            <returns>The result of the conversion.</returns>
        </member>
    </members>
</doc>