MediaStreamSourceStartingRequestDeferral Class

  • Reference

Definition

Namespace:
Windows.Media.Core
Edit

Provides a way for the application to asynchronously report that it has completed processing the MediaStreamSource.Starting event.

public ref class MediaStreamSourceStartingRequestDeferral sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class MediaStreamSourceStartingRequestDeferral final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class MediaStreamSourceStartingRequestDeferral
Public NotInheritable Class MediaStreamSourceStartingRequestDeferral
Inheritance
Object Platform::Object IInspectable MediaStreamSourceStartingRequestDeferral
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

You can use a deferral when you want to make an asynchronous call in response to the MediaStreamSource.Starting event. For example, if you need to establish a HTTP connection or open a file for reading. The MediaStreamSource will then wait for you to mark the deferral as complete before it begins raising the SampleRequested event.

To create a deferral, call the GetDeferral method on the MediaStreamSourceStartingRequest object to instruct the MediaStreamSource to wait for your asynchronous call to complete. When you are ready to start receiving SampleRequested events, call the Complete method to end the deferral.

See the MediaStreamSource Sample for an example of using Media Stream Source in a UWP app.

Methods

Complete()

Reports that the application has completed processing the Starting event.

Applies to

See also