VideoStabilizationEffect VideoStabilizationEffect VideoStabilizationEffect VideoStabilizationEffect Class

Definition

Represents an effect that stabilizes a video stream.

public : sealed class VideoStabilizationEffect : IVideoStabilizationEffect, IMediaExtensionpublic sealed class VideoStabilizationEffect : IVideoStabilizationEffect, IMediaExtensionPublic NotInheritable Class VideoStabilizationEffect Implements IVideoStabilizationEffect, IMediaExtension// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Get an instance of this class by passing a VideoStabilizationEffectDefinition object into MediaCapture.AddVideoEffectAsync or MediaTranscoder.AddVideoEffect.

For how-to guidance for using the VideoStabilizationEffect, see Effects for video capture.

Properties

Enabled Enabled Enabled Enabled

Gets or sets a value indicating whether video stabilization is enabled.

public : PlatForm::Boolean Enabled { get; set; }public bool Enabled { get; set; }Public ReadWrite Property Enabled As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if video stabilization is enabled; otherwise, false.

Methods

GetRecommendedStreamConfiguration(VideoDeviceController, VideoEncodingProperties) GetRecommendedStreamConfiguration(VideoDeviceController, VideoEncodingProperties) GetRecommendedStreamConfiguration(VideoDeviceController, VideoEncodingProperties) GetRecommendedStreamConfiguration(VideoDeviceController, VideoEncodingProperties)

Gets the recommended video stream configuration for video stabilization, given the specified video device controller and encoding properties.

public : VideoStreamConfiguration GetRecommendedStreamConfiguration(VideoDeviceController controller, VideoEncodingProperties desiredProperties)public VideoStreamConfiguration GetRecommendedStreamConfiguration(VideoDeviceController controller, VideoEncodingProperties desiredProperties)Public Function GetRecommendedStreamConfiguration(controller As VideoDeviceController, desiredProperties As VideoEncodingProperties) As VideoStreamConfiguration// You can use this method in JavaScript.
Parameters
Returns

An object representing the optimal video stream configuration for video stabilization.

SetProperties(IPropertySet) SetProperties(IPropertySet) SetProperties(IPropertySet) SetProperties(IPropertySet)

Sets properties on the IMediaExtension.

public : void SetProperties(IPropertySet configuration)public void SetProperties(IPropertySet configuration)Public Function SetProperties(configuration As IPropertySet) As void// You can use this method in JavaScript.
Parameters
configuration
IPropertySet IPropertySet IPropertySet IPropertySet

The property set.

Remarks

This method is inherited from the IMediaExtension interface and is not intended to be used from your code. Instead, set the properties of the VideoStabilizationEffect directly.

Events

EnabledChanged EnabledChanged EnabledChanged EnabledChanged

Occurs when the value of the VideoStabilizationEffect::Enabled property changes.

public : event TypedEventHandler EnabledChanged<VideoStabilizationEffect,  VideoStabilizationEffectEnabledChangedEventArgs>public event TypedEventHandler EnabledChanged<VideoStabilizationEffect,  VideoStabilizationEffectEnabledChangedEventArgs>Public Event EnabledChanged<VideoStabilizationEffect,  VideoStabilizationEffectEnabledChangedEventArgs>// You can use this event in JavaScript.

See Also