Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

MediaCapture.StartPreviewToCustomSinkAsync(MediaEncodingProfile, IMediaExtension) | startPreviewToCustomSinkAsync(MediaEncodingProfile, IMediaExtension) method

Starts sending a preview stream to a custom media sink using the specified encoding profile.

Syntax


mediaCapture.startPreviewToCustomSinkAsync(encodingProfile, customMediaSink).done( /* Your success and error handlers */ );

Parameters

encodingProfile

Type: MediaEncodingProfile

The encoding profile to use for the recording.

customMediaSink

Type: IMediaExtension

The media extension for the custom media sink.

Return value

Type: IAsyncAction

An object that is used to control the asynchronous operation.

Remarks

When you call StartPreviewToCustomSinkAsync, the system will call the custom sink’s IMFMediaTypeHandler::IsMediaTypeSupported method, passing in the native media type of the capture device. This check is performed in an effort to avoid unnecessary video conversion. If the custom sink returns S_OK from IsMediaTypeSupported when this check is made, then the preview stream will use the native media type instead of the type specified by the encodingProfile parameter.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Media.Capture
Windows::Media::Capture [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Media.Capture
Windows::Media::Capture [C++]

Metadata

Windows.winmd

See also

MediaCapture
StartPreviewToCustomSinkAsync(MediaEncodingProfile, String, IPropertySet)

 

 

Show: