Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>SharpDX.MediaFoundation</name>
</assembly>
<members>
<member name="T:SharpDX.MediaFoundation.Activate">
<summary>
<p>Enables the application to defer the creation of an object. This interface is exposed by activation objects.</p>
</summary>
<remarks>
<p>Typically, the application calls some function that returns an <strong><see cref="T:SharpDX.MediaFoundation.Activate" /></strong> reference and then passes that reference to another component. The other component calls <strong>ActivateObject</strong> at a later time to create the object. In the protected media path (PMP), the <strong><see cref="T:SharpDX.MediaFoundation.Activate" /></strong> reference might be marshaled to the protected process, so that the object can be created in that process.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFActivate']/*" />
<msdn-id>ms703039</msdn-id>
<unmanaged>IMFActivate</unmanaged>
<unmanaged-short>IMFActivate</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.Activate.#ctor(System.String,SharpDX.ComObject)">
<summary>
Creates an activation object for a Windows Runtime class.
</summary>
<param name="activatableClassId"><dd> <p>The class identifier that is associated with the activatable runtime class.</p> </dd></param>
<param name="propertySet"><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>
<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>
<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.Activate.ActivateObject``1(System.Guid)">
<summary>
<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>
<returns><dd> <p> A reference to the requested interface. The caller must release the interface. </p> </dd></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.ActivateObject``1">
<summary>
<p> Creates the object associated with this activation object. Riid is provided via reflection on the COM object type </p>
</summary>
<returns><dd> <p> A reference to the requested interface. The caller must release the interface. </p> </dd></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.#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> 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> </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> </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.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.AsyncCallbackBase">
<summary>
A default implementation of AsyncCallbackBase.
</summary>
</member>
<member name="T:SharpDX.MediaFoundation.AsyncCallbackShadow">
<summary>
Internal AsyncCallback Callback
</summary>
</member>
<member name="M:SharpDX.MediaFoundation.AsyncCallbackShadow.ToIntPtr(SharpDX.MediaFoundation.IAsyncCallback)">
<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.AsyncCallbackShadow.AsyncCallbackVtbl.GetParametersDelegate">
<unmanaged>HRESULT IMFAsyncCallback::GetParameters([Out] MFASYNC_CALLBACK_FLAGS* pdwFlags,[Out] unsigned int* pdwQueue)</unmanaged>
</member>
<member name="T:SharpDX.MediaFoundation.AsyncCallbackShadow.AsyncCallbackVtbl.InvokeDelegate">
<unmanaged>HRESULT IMFAsyncCallback::Invoke([In, Optional] IMFAsyncResult* pAsyncResult)</unmanaged>
</member>
<member name="T:SharpDX.MediaFoundation.AsyncResult">
<summary>
<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.IAsyncCallback.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,System.IntPtr,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="P:SharpDX.MediaFoundation.AsyncResult.State">
<summary>
Gets the state object specified by the caller in the asynchronous <strong>Begin</strong> method. If the value is not <strong><c>null</c></strong>, the caller must dispose.
</summary>
<value>The state.</value>
<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,System.IntPtr,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>
<msdn-id>bb970576</msdn-id>
<unmanaged>HRESULT IMFAsyncResult::GetState([Out] IUnknown** ppunkState)</unmanaged>
<unmanaged-short>IMFAsyncResult::GetState</unmanaged-short>
</member>
<member name="P:SharpDX.MediaFoundation.AsyncResult.Status">
<summary>
<p>Get or sets the status of the asynchronous operation.</p>
</summary>
<value><p>The method returns an <strong><see cref="T:SharpDX.Result"/></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return 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></value>
<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>
<msdn-id>ms702095</msdn-id>
<unmanaged>HRESULT IMFAsyncResult::GetStatus()</unmanaged>
<unmanaged-short>IMFAsyncResult::GetStatus</unmanaged-short>
</member>
<member name="P:SharpDX.MediaFoundation.AsyncResult.PrivateObject">
<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>
<value><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></value>
<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,System.IntPtr,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>
<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.#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(System.IntPtr@)">
<summary>
<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,System.IntPtr,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] void** ppunkState)</unmanaged>
<unmanaged-short>IMFAsyncResult::GetState</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.AsyncResult.GetStatus">
<summary>
<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> </p><p>Sets the status of the asynchronous operation.</p>
</summary>
<param name="hrStatus"><dd> <p>The status of the asynchronous operation.</p> </dd></param>
<returns><p>The method returns an <strong><see cref="T:SharpDX.Result" /></strong>. Possible values include, but are not limited to, those in the following table.</p><table> <tr><th>Return code</th><th>Description</th></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 implement an asynchronous method, call <strong>SetStatus</strong> to set the status code for the operation.</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::SetStatus']/*" />
<msdn-id>bb970435</msdn-id>
<unmanaged>HRESULT IMFAsyncResult::SetStatus([In] HRESULT hrStatus)</unmanaged>
<unmanaged-short>IMFAsyncResult::SetStatus</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.AsyncResult.GetObject(SharpDX.ComObject@)">
<summary>
<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,System.IntPtr,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> </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="T:SharpDX.MediaFoundation.AudioDecoder">
<summary>
Decoder from compressed audio (mp3, wma...etc.) to PCM.
</summary>
<remarks>
This class was developed following the <a href="http://msdn.microsoft.com/en-us/library/windows/desktop/dd757929%28v=vs.85%29.aspx">"Tutorial: Decoding Audio"</a>
</remarks>
</member>
<member name="M:SharpDX.MediaFoundation.AudioDecoder.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.AudioDecoder" /> class.
</summary>
</member>
<member name="M:SharpDX.MediaFoundation.AudioDecoder.#ctor(System.IO.Stream)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.AudioDecoder" /> class.
</summary>
<param name="stream">The stream to read the compressed audio.</param>
</member>
<member name="M:SharpDX.MediaFoundation.AudioDecoder.SetSourceStream(System.IO.Stream)">
<summary>
Gets or sets the source stream. See remarks.
</summary>
<value>The source.</value>
<remarks>
The source must be set before calling <see cref="M:SharpDX.MediaFoundation.AudioDecoder.GetSamples"/>
</remarks>
</member>
<member name="P:SharpDX.MediaFoundation.AudioDecoder.Duration">
<summary>
Gets the total duration in seconds.
</summary>
<value>The duration.</value>
</member>
<member name="P:SharpDX.MediaFoundation.AudioDecoder.WaveFormat">
<summary>
Gets the PCM wave format output by this decoder.
</summary>
<value>The wave format.</value>
</member>
<member name="M:SharpDX.MediaFoundation.AudioDecoder.GetSamples">
<summary>
Gets the decoded PCM samples. See remarks.
</summary>
<returns>An enumerator of pointer to PCM decoded data with the same format as returned by <see cref="P:SharpDX.MediaFoundation.AudioDecoder.WaveFormat"/>.</returns>
<remarks>
This method is only working as a single enumerator at a time.
</remarks>
<remarks>
The <see cref="!:Source"/> must be set before calling <see cref="M:SharpDX.MediaFoundation.AudioDecoder.GetSamples"/>
</remarks>
</member>
<member name="M:SharpDX.MediaFoundation.AudioDecoder.GetSamples(System.TimeSpan)">
<summary>
Gets the decoded PCM samples. See remarks.
</summary>
<param name="startingPositionInSeconds">The starting position in seconds.</param>
<returns>An enumerator of pointer to PCM decoded data with the same format as returned by <see cref="P:SharpDX.MediaFoundation.AudioDecoder.WaveFormat"/>.</returns>
<remarks>
This method is only working as a single enumerator at a time.
The <see cref="M:SharpDX.MediaFoundation.AudioDecoder.SetSourceStream(System.IO.Stream)"/> must be set before calling <see cref="M:SharpDX.MediaFoundation.AudioDecoder.GetSamples"/>
</remarks>
</member>
<member name="T:SharpDX.MediaFoundation.ByteStream">
<summary>
ByteStream class used
</summary>
<summary>
<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.IByteStream" /></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.IByteStream" /></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,System.IntPtr,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.IByteStream@)" /></strong> </li> <li> <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateTempFile(SharpDX.MediaFoundation.FileAccessMode,SharpDX.MediaFoundation.FileOpenMode,SharpDX.MediaFoundation.FileFlags,SharpDX.MediaFoundation.IByteStream@)" /></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.IO.Stream)">
<summary>
Instantiates a new instance <see cref="T:SharpDX.MediaFoundation.ByteStream"/> from a <see cref="T:System.IO.Stream"/>.
</summary>
<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.ByteStream.#ctor(System.Byte[])">
<summary>
Instantiates a new instance <see cref="T:SharpDX.MediaFoundation.ByteStream"/> from a <see cref="T:System.IO.Stream"/>.
</summary>
<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.ByteStream.#ctor(SharpDX.Win32.ComStream)">
<summary>
Instantiates a new instance <see cref="T:SharpDX.MediaFoundation.ByteStream"/> from a <see cref="T:System.IO.Stream"/>.
</summary>
<msdn-id>hh162754</msdn-id>
<unmanaged>HRESULT MFCreateMFByteStreamOnStreamEx([In] IUnknown* punkStream,[Out] IMFByteStream** ppByteStream)</unmanaged>
<unmanaged-short>MFCreateMFByteStreamOnStreamEx</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>
<returns>The capabilities of the stream.</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>
<msdn-id>ms698962</msdn-id>
<unmanaged>HRESULT IMFByteStream::GetCapabilities([Out] unsigned int* pdwCapabilities)</unmanaged>
<unmanaged-short>IMFByteStream::GetCapabilities</unmanaged-short>
</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>
<returns>The length of the stream, in bytes. If the length is unknown, this value is -1.</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>
<msdn-id>ms698941</msdn-id>
<unmanaged>HRESULT IMFByteStream::GetLength([Out] unsigned longlong* pqwLength)</unmanaged>
<unmanaged-short>IMFByteStream::GetLength</unmanaged-short>
</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>
<returns>The current position, in bytes.</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>
<msdn-id>ms704059</msdn-id>
<unmanaged>HRESULT IMFByteStream::GetCurrentPosition([Out] unsigned longlong* pqwPosition)</unmanaged>
<unmanaged-short>IMFByteStream::GetCurrentPosition</unmanaged-short>
</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>
<returns>true if the end of the stream has been reached</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>
<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="offset">Offset into the buffer.</param>
<param name="count"><dd> <p> Size of the buffer in bytes. </p> </dd></param>
<returns>The number of bytes that are copied into the buffer</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>
<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,System.Int32,SharpDX.MediaFoundation.IAsyncCallback,System.Object)">
<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="offset">The offset in the buffer to begin reading from.</param>
<param name="count"><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.IAsyncCallback"/></strong> interface of a callback object. The caller must implement this interface. </p> </dd></param>
<param name="context"><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.IAsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.IByteStream.EndRead(SharpDX.MediaFoundation.AsyncResult)"/></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>
<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)">
<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.IAsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method. </p> </dd></param>
<returns>The number of bytes that were read</returns>
<remarks>
<p> Call this method after the <strong><see cref="M:SharpDX.MediaFoundation.IByteStream.BeginRead(System.Byte[],System.Int32,System.Int32,SharpDX.MediaFoundation.IAsyncCallback,System.Object)"/></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>
<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="offset">The offset within the buffer to begin writing at.</param>
<param name="count"><dd> <p> Size of the buffer in bytes. </p> </dd></param>
<returns>The number of bytes that are written.</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>
<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,System.Int32,SharpDX.MediaFoundation.IAsyncCallback,System.Object)">
<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="offset">The offset within the buffer to begin writing at.</param>
<param name="count"><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.IAsyncCallback"/></strong> interface of a callback object. The caller must implement this interface. </p> </dd></param>
<param name="context"><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.IAsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.IByteStream.EndWrite(SharpDX.MediaFoundation.AsyncResult)"/></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>
<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)">
<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.IAsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)"/></strong> method.</p> </dd></param>
<returns>The number of bytes that were written</returns>
<remarks>
<p> Call this method when the <strong><see cref="M:SharpDX.MediaFoundation.IByteStream.BeginWrite(System.Byte[],System.Int32,System.Int32,SharpDX.MediaFoundation.IAsyncCallback,System.Object)"/></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>
<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)">
<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="!: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>
<returns>The new position after the seek</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>
<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>
<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>
<msdn-id>ms703909</msdn-id>
<unmanaged>HRESULT IMFByteStream::Close()</unmanaged>
<unmanaged-short>IMFByteStream::Close</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> 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> <strong>Note</strong>??Requires Windows?7 or later. ? </td></tr> <tr><td><dl> <dt><strong>MFBYTESTREAM_DOES_NOT_USE_NETWORK</strong></dt> <dt>0x00000800</dt> </dl> </td><td> <p>The byte stream is not currentlyusing the network to receive the content. Networking hardwaremay enter a power saving state when this bit is set.</p> <strong>Note</strong>??Requires Windows?8 or later. ? </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> 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> </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> 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> </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><strong> Implementation notes:</strong> This method should update the current position in the stream by setting the current position to the value passed in to the <em>qwPosition</em> parameter. Other methods that can update the current position are <strong>Read</strong>, <strong>BeginRead</strong>, <strong>Write</strong>, <strong>BeginWrite</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::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_(SharpDX.Mathematics.Interop.RawBool@)">
<summary>
<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.IntPtr,System.Int32,System.Int32@)">
<summary>
<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><strong> Implementation notes:</strong> This method should update the current position in the stream by adding the number of bytes that were read, which is specified by the value returned in the <em>pcbRead</em> parameter, to the current position. Other methods that can update the current position are <strong>Read</strong>, <strong>Write</strong>, <strong>BeginWrite</strong>, <strong>Seek</strong>, and <strong>SetCurrentPosition</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::Read']/*" />
<msdn-id>ms698913</msdn-id>
<unmanaged>HRESULT IMFByteStream::Read([In] void* 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.IntPtr,System.Int32,System.IntPtr,System.IntPtr)">
<summary>
<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.IAsyncCallback" /></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.IAsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)" /></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.IByteStream.EndRead(SharpDX.MediaFoundation.AsyncResult)" /></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><strong> Implementation notes:</strong> This method should update the current position in the stream by adding the number of bytes that will be read, which is specified by the value returned in the <em>pcbRead</em> parameter, to the current position. Other methods that can update the current position are <strong>BeginRead</strong>, <strong>Write</strong>, <strong>BeginWrite</strong>, <strong>Seek</strong>, and <strong>SetCurrentPosition</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::BeginRead']/*" />
<msdn-id>ms704810</msdn-id>
<unmanaged>HRESULT IMFByteStream::BeginRead([In] void* pb,[In] unsigned int cb,[In] IMFAsyncCallback* pCallback,[In] void* punkState)</unmanaged>
<unmanaged-short>IMFByteStream::BeginRead</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.ByteStream.EndRead_(SharpDX.MediaFoundation.AsyncResult,System.Int32@)">
<summary>
<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.IAsyncCallback.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="!:SharpDX.MediaFoundation.IByteStream.BeginRead_" /></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.IntPtr,System.Int32,System.Int32@)">
<summary>
<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><strong>Implementation notes:</strong> This method should update the current position in the stream by adding the number of bytes that were written to the stream, which is specified by the value returned in the <em>pcbWritten</em>, to the current position offset. </p><p> Other methods that can update the current position are <strong>Read</strong>, <strong>BeginRead</strong>, <strong>BeginWrite</strong>, <strong>Seek</strong>, and <strong>SetCurrentPosition</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::Write']/*" />
<msdn-id>ms703843</msdn-id>
<unmanaged>HRESULT IMFByteStream::Write([In] const void* 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.IntPtr,System.Int32,System.IntPtr,System.IntPtr)">
<summary>
<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.IAsyncCallback" /></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.IAsyncCallback.Invoke(SharpDX.MediaFoundation.AsyncResult)" /></strong> method is called. At that point, the application should call <strong><see cref="M:SharpDX.MediaFoundation.IByteStream.EndWrite(SharpDX.MediaFoundation.AsyncResult)" /></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><strong>Implementation notes:</strong> This method should update the current position in the stream by adding the number of bytes that will be written to the stream, which is specified by the value returned in the <em>pcbWritten</em>, to the current position. Other methods that can update the current position are <strong>Read</strong>, <strong>BeginRead</strong>, <strong>Write</strong>, <strong>Seek</strong>, and <strong>SetCurrentPosition</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::BeginWrite']/*" />
<msdn-id>ms694005</msdn-id>
<unmanaged>HRESULT IMFByteStream::BeginWrite([In] const void* pb,[In] unsigned int cb,[In] IMFAsyncCallback* pCallback,[In] void* punkState)</unmanaged>
<unmanaged-short>IMFByteStream::BeginWrite</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.ByteStream.EndWrite_(SharpDX.MediaFoundation.AsyncResult,System.Int32@)">
<summary>
<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.IAsyncCallback.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="!:SharpDX.MediaFoundation.IByteStream.BeginWrite_" /></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> </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><p><strong> Implementation notes:</strong> This method should update the current position in the stream by adding the <em>qwSeekOffset</em> to the seek <em>SeekOrigin</em> position. This should be the same value passed back in the <em>pqwCurrentPosition</em> parameter.
Other methods that can update the current position are <strong>Read</strong>, <strong>BeginRead</strong>, <strong>Write</strong>, <strong>BeginWrite</strong>, and <strong>SetCurrentPosition</strong>.
</p>
</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> 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> 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="T:SharpDX.MediaFoundation.CaptureEngine">
<summary>
<p>Controls one or more capture devices. The capture engine implements this interface. To get a reference to this interface, call either <strong>MFCreateCaptureEngine</strong> or <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngineClassFactory.CreateInstance(System.Guid,System.Guid,System.IntPtr@)" /></strong>.</p>
</summary>
<remarks>
<p><strong><see cref="T:SharpDX.MediaFoundation.CaptureEngine" /></strong> only supports one pass CBR encoding.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCaptureEngine']/*" />
<msdn-id>hh447846</msdn-id>
<unmanaged>IMFCaptureEngine</unmanaged>
<unmanaged-short>IMFCaptureEngine</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.#ctor(SharpDX.MediaFoundation.CaptureEngineClassFactory)">
<summary>
<p>Creates an instance of the capture engine.</p>
</summary>
<param name="clsid"><dd> <p>The CLSID of the object to create. Currently, this parameter must equal <strong><see cref="F:SharpDX.MediaFoundation.CaptureEngine.ClsidMFCaptureEngine" /></strong>.</p> </dd></param>
<param name="riid"><dd> <p>The IID of the requested interface. The capture engine supports the <strong><see cref="T:SharpDX.MediaFoundation.CaptureEngine" /></strong> 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>Before calling this method, call the <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.Startup(System.Int32,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='IMFCaptureEngineClassFactory::CreateInstance']/*" />
<msdn-id>hh447848</msdn-id>
<unmanaged>HRESULT IMFCaptureEngineClassFactory::CreateInstance([In] const GUID& clsid,[In] const GUID& riid,[Out] void** ppvObject)</unmanaged>
<unmanaged-short>IMFCaptureEngineClassFactory::CreateInstance</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.Initialize(SharpDX.MediaFoundation.MediaAttributes,SharpDX.ComObject,SharpDX.ComObject)">
<summary>
<p>Initializes the capture engine.</p>
</summary>
<param name="eventCallbackRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.CaptureEngineOnEventCallback" /></strong> interface. The caller must implement this interface. The capture engine uses this interface to send asynchronous events to the caller.</p> </dd></param>
<param name="attributesRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes" /></strong> interface. This parameter can be <strong><c>null</c></strong>. </p> <p>You can use this parameter to configure the capture engine. Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAttributes(SharpDX.MediaFoundation.MediaAttributes,System.Int32)" /></strong> to create an attribute store, and then set any of the following attributes.</p> <ul> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.D3DManager" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.DisableDXVA" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.DisableHardwareTransforms" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.EncoderTransformFieldOfUseUnlockAttribute" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.EventGeneratorGuid" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.EventStreamIndex" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.MediaSourceConfig" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.RecordSinkAudioMaxProcessedSamples" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.RecordSinkAudioMaxUnprocessedSamples" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.RecordSinkVideoMaxProcessedSamples" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.RecordSinkVideoMaxUnprocessedSamples" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.UseAudioDeviceOnly" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.UseVideoDeviceOnly" /> </li> </ul> </dd></param>
<param name="audioSourceRef"><dd> <p>An <strong><see cref="T:SharpDX.ComObject" /></strong> reference that specifies an audio-capture device. This parameter can be <strong><c>null</c></strong>.</p> <p>If you set the <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.UseVideoDeviceOnly" /> attribute to <strong>TRUE</strong> in <em>pAttributes</em>, the capture engine does not use an audio device, and the <em>pAudioSource</em> parameter is ignored.</p> <p>Otherwise, if <em>pAudioSource</em> is <strong><c>null</c></strong>, the capture engine selects the microphone that is built into the video camera specified by <em>pVideoSource</em>. If the video camera does not have a microphone, the capture engine enumerates the audio-capture devices on the system and selects the first one.</p> <p>To override the default audio device, set <em>pAudioSource</em> to an <strong><see cref="T:SharpDX.MediaFoundation.MediaSource" /></strong> or <strong><see cref="T:SharpDX.MediaFoundation.Activate" /></strong> reference for the device. For more information, see Audio/Video Capture in Media Foundation.</p> </dd></param>
<param name="videoSourceRef"><dd> <p>An <strong><see cref="T:SharpDX.ComObject" /></strong> reference that specifies a video-capture device. This parameter can be <strong><c>null</c></strong>.</p> <p>If you set the <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.UseAudioDeviceOnly" /> attribute to <strong>TRUE</strong> in <em>pAttributes</em>, the capture engine does not use a video device, and the <em>pVideoSource</em> parameter is ignored.</p> <p>Otherwise, if <em>pVideoSource</em> is <strong><c>null</c></strong>, the capture engine enumerates the video-capture devices on the system and selects the first one.</p> <p>To override the default video device, set <em>pVideoSource</em> to an <strong><see cref="T:SharpDX.MediaFoundation.MediaSource" /></strong> or <strong><see cref="T:SharpDX.MediaFoundation.Activate" /></strong> reference for the device. For more information, see Enumerating Video Capture Devices.</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><see cref="F:SharpDX.MediaFoundation.ResultCode.InvalidRequest" /></strong></dt> </dl> </td><td> <p>The <strong>Initialize</strong> method was already called.</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.ResultCode.NoCaptureDevicesAvailable" /></strong></dt> </dl> </td><td> <p>No capture devices are available.</p> </td></tr> </table><p> </p></returns>
<remarks>
<p>You must call this method once before using the capture engine. Calling the method a second time returns <strong><see cref="F:SharpDX.MediaFoundation.ResultCode.InvalidRequest" /></strong>.</p><p>This method is asynchronous. If the method returns a success code, the caller will receive an <strong>MF_CAPTURE_ENGINE_INITIALIZED</strong> event through the <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngineOnEventCallback.OnEvent(SharpDX.MediaFoundation.MediaEvent)" /></strong> method. The operation can fail asynchronously after the method succeeds. If so, the error code is conveyed through the <strong>OnEvent</strong> method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file="Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCaptureEngine::Initialize']/*" />
<msdn-id>hh447855</msdn-id>
<unmanaged>HRESULT IMFCaptureEngine::Initialize([In] IMFCaptureEngineOnEventCallback* pEventCallback,[In, Optional] IMFAttributes* pAttributes,[In, Optional] IUnknown* pAudioSource,[In, Optional] IUnknown* pVideoSource)</unmanaged>
<unmanaged-short>IMFCaptureEngine::Initialize</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.CaptureEngine"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.CaptureEngine">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.MediaFoundation.CaptureEngine"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="F:SharpDX.MediaFoundation.CaptureEngine.ClsidMFCaptureEngine">
<summary>Constant ClsidMFCaptureEngine.</summary>
<unmanaged>CLSID_MFCaptureEngine</unmanaged>
</member>
<member name="P:SharpDX.MediaFoundation.CaptureEngine.Source">
<summary>
<p>Gets a reference to the capture source object. Use the capture source to configure the capture devices.</p>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCaptureEngine::GetSource']/*" />
<msdn-id>hh447854</msdn-id>
<unmanaged>GetSource</unmanaged>
<unmanaged-short>GetSource</unmanaged-short>
<unmanaged>HRESULT IMFCaptureEngine::GetSource([Out] IMFCaptureSource** ppSource)</unmanaged>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.Initialize_(System.IntPtr,SharpDX.MediaFoundation.MediaAttributes,SharpDX.ComObject,SharpDX.ComObject)">
<summary>
<p>Initializes the capture engine.</p>
</summary>
<param name="eventCallbackRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.CaptureEngineOnEventCallback" /></strong> interface. The caller must implement this interface. The capture engine uses this interface to send asynchronous events to the caller.</p> </dd></param>
<param name="attributesRef"><dd> <p>A reference to the <strong><see cref="T:SharpDX.MediaFoundation.MediaAttributes" /></strong> interface. This parameter can be <strong><c>null</c></strong>. </p> <p>You can use this parameter to configure the capture engine. Call <strong><see cref="M:SharpDX.MediaFoundation.MediaFactory.CreateAttributes(SharpDX.MediaFoundation.MediaAttributes,System.Int32)" /></strong> to create an attribute store, and then set any of the following attributes.</p> <ul> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.D3DManager" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.DisableDXVA" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.DisableHardwareTransforms" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.EncoderTransformFieldOfUseUnlockAttribute" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.EventGeneratorGuid" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.EventStreamIndex" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.MediaSourceConfig" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.RecordSinkAudioMaxProcessedSamples" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.RecordSinkAudioMaxUnprocessedSamples" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.RecordSinkVideoMaxProcessedSamples" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.RecordSinkVideoMaxUnprocessedSamples" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.UseAudioDeviceOnly" /> </li> <li> <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.UseVideoDeviceOnly" /> </li> </ul> </dd></param>
<param name="audioSourceRef"><dd> <p>An <strong><see cref="T:SharpDX.ComObject" /></strong> reference that specifies an audio-capture device. This parameter can be <strong><c>null</c></strong>.</p> <p>If you set the <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.UseVideoDeviceOnly" /> attribute to <strong>TRUE</strong> in <em>pAttributes</em>, the capture engine does not use an audio device, and the <em>pAudioSource</em> parameter is ignored.</p> <p>Otherwise, if <em>pAudioSource</em> is <strong><c>null</c></strong>, the capture engine selects the microphone that is built into the video camera specified by <em>pVideoSource</em>. If the video camera does not have a microphone, the capture engine enumerates the audio-capture devices on the system and selects the first one.</p> <p>To override the default audio device, set <em>pAudioSource</em> to an <strong><see cref="T:SharpDX.MediaFoundation.MediaSource" /></strong> or <strong><see cref="T:SharpDX.MediaFoundation.Activate" /></strong> reference for the device. For more information, see Audio/Video Capture in Media Foundation.</p> </dd></param>
<param name="videoSourceRef"><dd> <p>An <strong><see cref="T:SharpDX.ComObject" /></strong> reference that specifies a video-capture device. This parameter can be <strong><c>null</c></strong>.</p> <p>If you set the <see cref="F:SharpDX.MediaFoundation.CaptureEngineAttributeKeys.UseAudioDeviceOnly" /> attribute to <strong>TRUE</strong> in <em>pAttributes</em>, the capture engine does not use a video device, and the <em>pVideoSource</em> parameter is ignored.</p> <p>Otherwise, if <em>pVideoSource</em> is <strong><c>null</c></strong>, the capture engine enumerates the video-capture devices on the system and selects the first one.</p> <p>To override the default video device, set <em>pVideoSource</em> to an <strong><see cref="T:SharpDX.MediaFoundation.MediaSource" /></strong> or <strong><see cref="T:SharpDX.MediaFoundation.Activate" /></strong> reference for the device. For more information, see Enumerating Video Capture Devices.</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><see cref="F:SharpDX.MediaFoundation.ResultCode.InvalidRequest" /></strong></dt> </dl> </td><td> <p>The <strong>Initialize</strong> method was already called.</p> </td></tr> <tr><td> <dl> <dt><strong><see cref="F:SharpDX.MediaFoundation.ResultCode.NoCaptureDevicesAvailable" /></strong></dt> </dl> </td><td> <p>No capture devices are available.</p> </td></tr> </table><p>?</p></returns>
<remarks>
<p>You must call this method once before using the capture engine. Calling the method a second time returns <strong><see cref="F:SharpDX.MediaFoundation.ResultCode.InvalidRequest" /></strong>.</p><p>This method is asynchronous. If the method returns a success code, the caller will receive an <strong>MF_CAPTURE_ENGINE_INITIALIZED</strong> event through the <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngineOnEventCallback.OnEvent(SharpDX.MediaFoundation.MediaEvent)" /></strong> method. The operation can fail asynchronously after the method succeeds. If so, the error code is conveyed through the <strong>OnEvent</strong> method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCaptureEngine::Initialize']/*" />
<msdn-id>hh447855</msdn-id>
<unmanaged>HRESULT IMFCaptureEngine::Initialize([In] IMFCaptureEngineOnEventCallback* pEventCallback,[In, Optional] IMFAttributes* pAttributes,[In, Optional] IUnknown* pAudioSource,[In, Optional] IUnknown* pVideoSource)</unmanaged>
<unmanaged-short>IMFCaptureEngine::Initialize</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.StartPreview">
<summary>
<p>Starts preview.</p>
</summary>
<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.MediaFoundation.ResultCode.InvalidRequest" /></strong></dt> </dl> </td><td> <p>The preview sink was not initialized.</p> </td></tr> </table><p>?</p></returns>
<remarks>
<p>Before calling this method, configure the preview sink by calling <strong><see cref="M:SharpDX.MediaFoundation.CaptureSink.AddStream(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaAttributes,System.Int32@)" /></strong>. To get a reference to the preview sink, call <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngine.GetSink(SharpDX.MediaFoundation.CaptureEngineSinkType,SharpDX.MediaFoundation.CaptureSink@)" /></strong>. </p><p>This method is asynchronous. If the method returns a success code, the caller will receive an <strong>MF_CAPTURE_ENGINE_PREVIEW_STARTED</strong> event through the <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngineOnEventCallback.OnEvent(SharpDX.MediaFoundation.MediaEvent)" /></strong> method. The operation can fail asynchronously after the method succeeds. If so, the error code is conveyed through the <strong>OnEvent</strong> method.</p><p>After the preview sink is configured, you can stop and start preview by calling <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngine.StopPreview" /></strong> and <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngine.StartPreview" /></strong>.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCaptureEngine::StartPreview']/*" />
<msdn-id>hh447856</msdn-id>
<unmanaged>HRESULT IMFCaptureEngine::StartPreview()</unmanaged>
<unmanaged-short>IMFCaptureEngine::StartPreview</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.StopPreview">
<summary>
<p>Stops preview.</p>
</summary>
<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.MediaFoundation.ResultCode.InvalidRequest" /></strong></dt> </dl> </td><td> <p>The capture engine is not currently previewing.</p> </td></tr> </table><p>?</p></returns>
<remarks>
<p>This method is asynchronous. If the method returns a success code, the caller will receive an <strong>MF_CAPTURE_ENGINE_PREVIEW_STOPPED</strong> event through the <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngineOnEventCallback.OnEvent(SharpDX.MediaFoundation.MediaEvent)" /></strong> method. The operation can fail asynchronously after the method succeeds. If so, the error code is conveyed through the <strong>OnEvent</strong> method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCaptureEngine::StopPreview']/*" />
<msdn-id>hh447858</msdn-id>
<unmanaged>HRESULT IMFCaptureEngine::StopPreview()</unmanaged>
<unmanaged-short>IMFCaptureEngine::StopPreview</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.StartRecord">
<summary>
<p>Starts recording audio and/or video to a file.</p>
</summary>
<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.MediaFoundation.ResultCode.InvalidRequest" /></strong></dt> </dl> </td><td> <p>The recording sink was not initialized.</p> </td></tr> </table><p>?</p></returns>
<remarks>
<p>Before calling this method, configure the recording sink by calling <strong><see cref="M:SharpDX.MediaFoundation.CaptureSink.AddStream(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaAttributes,System.Int32@)" /></strong>. To get a reference to the recording sink, call <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngine.GetSink(SharpDX.MediaFoundation.CaptureEngineSinkType,SharpDX.MediaFoundation.CaptureSink@)" /></strong>.</p><p>This method is asynchronous. If the method returns a success code, the caller will receive an <strong>MF_CAPTURE_ENGINE_RECORD_STARTED</strong> event through the <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngineOnEventCallback.OnEvent(SharpDX.MediaFoundation.MediaEvent)" /></strong> method. The operation can fail asynchronously after the method succeeds. If so, the error code is conveyed through the <strong>OnEvent</strong> method.</p><p>To stop recording, call <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngine.StopRecord(SharpDX.Mathematics.Interop.RawBool,SharpDX.Mathematics.Interop.RawBool)" /></strong>.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCaptureEngine::StartRecord']/*" />
<msdn-id>hh447857</msdn-id>
<unmanaged>HRESULT IMFCaptureEngine::StartRecord()</unmanaged>
<unmanaged-short>IMFCaptureEngine::StartRecord</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.StopRecord(SharpDX.Mathematics.Interop.RawBool,SharpDX.Mathematics.Interop.RawBool)">
<summary>
<p>Stops recording.</p>
</summary>
<param name="bFinalize"><dd> <p>A Boolean value that specifies whether to finalize the output file. To create a valid output file, specify <strong>TRUE</strong>. Specify <strong><see cref="F:SharpDX.Result.False" /></strong> only if you want to interrupt the recording and discard the output file. If the value is <strong><see cref="F:SharpDX.Result.False" /></strong>, the operation completes more quickly, but the file will not be playable. </p> </dd></param>
<param name="bFlushUnprocessedSamples"><dd> <p>A Boolean value that specifies if the unprocessed samples waiting to be encoded should be flushed.</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. If the method returns a success code, the caller will receive an <strong>MF_CAPTURE_ENGINE_RECORD_STOPPED</strong> event through the <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngineOnEventCallback.OnEvent(SharpDX.MediaFoundation.MediaEvent)" /></strong> method. The operation can fail asynchronously after the method succeeds. If so, the error code is conveyed through the <strong>OnEvent</strong> method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCaptureEngine::StopRecord']/*" />
<msdn-id>hh447859</msdn-id>
<unmanaged>HRESULT IMFCaptureEngine::StopRecord([In] BOOL bFinalize,[In] BOOL bFlushUnprocessedSamples)</unmanaged>
<unmanaged-short>IMFCaptureEngine::StopRecord</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.TakePhoto">
<summary>
<p>Captures a still image from the video stream.</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>Before calling this method, configure the photo sink by calling <strong><see cref="M:SharpDX.MediaFoundation.CaptureSink.AddStream(System.Int32,SharpDX.MediaFoundation.MediaType,SharpDX.MediaFoundation.MediaAttributes,System.Int32@)" /></strong>. To get a reference to the photo sink, call <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngine.GetSink(SharpDX.MediaFoundation.CaptureEngineSinkType,SharpDX.MediaFoundation.CaptureSink@)" /></strong>. </p><p>This method is asynchronous. If the method returns a success code, the caller will receive an <strong>MF_CAPTURE_ENGINE_PHOTO_TAKEN</strong> event through the <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngineOnEventCallback.OnEvent(SharpDX.MediaFoundation.MediaEvent)" /></strong> method. The operation can fail asynchronously after the method succeeds. If so, the error code is conveyed through the <strong>OnEvent</strong> method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCaptureEngine::TakePhoto']/*" />
<msdn-id>hh447860</msdn-id>
<unmanaged>HRESULT IMFCaptureEngine::TakePhoto()</unmanaged>
<unmanaged-short>IMFCaptureEngine::TakePhoto</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.GetSink(SharpDX.MediaFoundation.CaptureEngineSinkType,SharpDX.MediaFoundation.CaptureSink@)">
<summary>
<p>Gets a reference to one of the capture sink objects. You can use the capture sinks to configure preview, recording, or still-image capture.</p>
</summary>
<param name="mfCaptureEngineSinkType"><dd> <p>An <strong><see cref="T:SharpDX.MediaFoundation.CaptureEngineSinkType" /></strong> value that specifies the capture sink to retrieve.</p> </dd></param>
<param name="sinkOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.CaptureSink" /></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_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='IMFCaptureEngine::GetSink']/*" />
<msdn-id>hh447853</msdn-id>
<unmanaged>HRESULT IMFCaptureEngine::GetSink([In] MF_CAPTURE_ENGINE_SINK_TYPE mfCaptureEngineSinkType,[Out] IMFCaptureSink** ppSink)</unmanaged>
<unmanaged-short>IMFCaptureEngine::GetSink</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngine.GetSource(SharpDX.MediaFoundation.CaptureSource@)">
<summary>
<p>Gets a reference to the capture source object. Use the capture source to configure the capture devices.</p>
</summary>
<param name="sourceOut"><dd> <p>Receives a reference to the <strong><see cref="T:SharpDX.MediaFoundation.CaptureSource" /></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>
<!-- No matching elements were found for the following include tag --><include file=".\..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IMFCaptureEngine::GetSource']/*" />
<msdn-id>hh447854</msdn-id>
<unmanaged>HRESULT IMFCaptureEngine::GetSource([Out] IMFCaptureSource** ppSource)</unmanaged>
<unmanaged-short>IMFCaptureEngine::GetSource</unmanaged-short>
</member>
<member name="T:SharpDX.MediaFoundation.CaptureEngineClassFactory">
<summary>
<p>Creates an instance of the capture engine.</p>
</summary>
<remarks>
<p>To get a reference to this interface, call the CoCreateInstance function and specify the CLSID equal to <strong><see cref="F:SharpDX.MediaFoundation.CaptureEngineClassFactory.ClsidMFCaptureEngineClassFactory" /></strong>. </p><p>Calling the <strong>MFCreateCaptureEngine</strong> function is equivalent to calling <strong><see cref="M:SharpDX.MediaFoundation.CaptureEngineClassFactory.CreateInstance(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='IMFCaptureEngineClassFactory']/*" />
<msdn-id>hh447847</msdn-id>
<unmanaged>IMFCaptureEngineClassFactory</unmanaged>
<unmanaged-short>IMFCaptureEngineClassFactory</unmanaged-short>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngineClassFactory.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.MediaFoundation.CaptureEngineClassFactory"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.MediaFoundation.CaptureEngineClassFactory.op_Explicit(System.IntPtr)~SharpDX.MediaFoundation.CaptureEngineClassFactory">