IBasicVideoEffect Interface

Definition

The interface you implement to create a custom video effect.

public interface class IBasicVideoEffect : IMediaExtension
struct IBasicVideoEffect : IMediaExtension
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(2187511791, 45920, 16574, 148, 155, 47, 244, 47, 243, 86, 147)]
public interface IBasicVideoEffect : IMediaExtension
Public Interface IBasicVideoEffect
Implements IMediaExtension
Attributes
Implements

Windows 10 requirements

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

Properties

IsReadOnly

Gets a value indicating whether the video effect will modify the contents of the input frame.

SupportedEncodingProperties

Gets the encoding properties supported by the custom video effect.

SupportedMemoryTypes

Gets a value that indicates whether the custom video effect supports the use of GPU memory or CPU memory.

TimeIndependent

Gets a value that indicates whether the custom video effect is time independent.

Methods

Close(MediaEffectClosedReason)

Called when the video effect should close and clean up allocated resources.

DiscardQueuedFrames()

Called to allow video effect implementations optionally discard any stored state related to frames that have already been received.

ProcessFrame(ProcessVideoFrameContext)

Called when frames are available for processing by a custom video effect.

SetEncodingProperties(VideoEncodingProperties, IDirect3DDevice)

Called to set the encoding properties of a custom video effect.

SetProperties(IPropertySet)

Sets the configuration properties that were supplied when the media parser or codec was registered.

(Inherited from IMediaExtension)

Applies to

See also