LowLagMediaRecording Class

  • Reference

Definition

Namespace:
Windows.Media.Capture
Edit

Provides methods for taking a low lag media recording.

public ref class LowLagMediaRecording sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
class LowLagMediaRecording final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
public sealed class LowLagMediaRecording
Public NotInheritable Class LowLagMediaRecording
Inheritance
Object Platform::Object IInspectable LowLagMediaRecording
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

Use the following methods on the MediaCapture class to initialize the recording, which must be called before StartAsync: PrepareLowLagRecordToStreamAsync, PrepareLowLagRecordToStorageFileAsync, and PrepareLowLagRecordToCustomSinkAsync. These are asynchronous methods which return a LowLagMediaRecording object when they are finished.

StopAsync stops the operation, which can be restarted with StartAsync.

FinishAsync stops the media recording operation and releases the LowLagMediaRecording object and resources used by the media recording operation. If you want to restart the recording after calling FinishAsync, you will need to call one of the PrepareLowLagRecord methods to initialize a new LowLagMediaRecording object.

If the media type is changed or an effect is added, you must call PrepareLowLagRecordToStreamAsync, PrepareLowLagRecordToStorageFileAsync, or PrepareLowLagRecordToCustomSinkAsync to create a new LowLagMediaRecording object.

For how-to guidance for using LowLagMediaCapture to capture video, see Basic photo, video, and audio capture with MediaCapture.

Version history

Windows version SDK version Value added
1607 14393 PauseWithResultAsync
1607 14393 StopWithResultAsync

Methods

FinishAsync()

Asynchronously releases the LowLagMediaRecording object and resources used by the media recording operation.
PauseAsync(MediaCapturePauseBehavior)

Pauses an ongoing low lag media record operation.
PauseWithResultAsync(MediaCapturePauseBehavior)

Pauses an ongoing low lag media record operation and provides a MediaCapturePauseResult that can be used to help the user align the camera with the last captured frame when resuming recording.
ResumeAsync()

Resumes a paused low lag recording operation.
StartAsync()

Asynchronously starts the low lag media recording.
StopAsync()

Asynchronously stops the low lag media recording.
StopWithResultAsync()

Asynchronously stops the low lag media recording and provides a MediaCaptureStopResult that can be used to help the user align the camera with the last captured frame when restarting recording.

Applies to

See also