IBasicVideoEffect IBasicVideoEffect IBasicVideoEffect IBasicVideoEffect IBasicVideoEffect Interface

Definition

The interface you implement to create a custom video effect.

public : interface IBasicVideoEffect : IMediaExtension
struct winrt::Windows::Media::Effects::IBasicVideoEffect : IMediaExtension
public interface IBasicVideoEffect : IMediaExtension
Public Interface IBasicVideoEffect Implements IMediaExtension
// You can't instantiate an interface directly in JavaScript. You can use objects that implement the interface, however.
Inheritance
IBasicVideoEffectIBasicVideoEffectIBasicVideoEffectIBasicVideoEffectIBasicVideoEffect
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

IsReadOnly IsReadOnly IsReadOnly IsReadOnly IsReadOnly

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

SupportedEncodingProperties SupportedEncodingProperties SupportedEncodingProperties SupportedEncodingProperties SupportedEncodingProperties

Gets the encoding properties supported by the custom video effect.

SupportedMemoryTypes SupportedMemoryTypes SupportedMemoryTypes SupportedMemoryTypes SupportedMemoryTypes

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

TimeIndependent TimeIndependent TimeIndependent TimeIndependent TimeIndependent

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

Methods

Close(MediaEffectClosedReason) Close(MediaEffectClosedReason) Close(MediaEffectClosedReason) Close(MediaEffectClosedReason) Close(MediaEffectClosedReason)

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

DiscardQueuedFrames() DiscardQueuedFrames() DiscardQueuedFrames() DiscardQueuedFrames() DiscardQueuedFrames()

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

ProcessFrame(ProcessVideoFrameContext) ProcessFrame(ProcessVideoFrameContext) ProcessFrame(ProcessVideoFrameContext) ProcessFrame(ProcessVideoFrameContext) ProcessFrame(ProcessVideoFrameContext)

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

SetEncodingProperties(VideoEncodingProperties, IDirect3DDevice) SetEncodingProperties(VideoEncodingProperties, IDirect3DDevice) SetEncodingProperties(VideoEncodingProperties, IDirect3DDevice) SetEncodingProperties(VideoEncodingProperties, IDirect3DDevice) SetEncodingProperties(VideoEncodingProperties, IDirect3DDevice)

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

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

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

(Inherited from IMediaExtension)

See Also