Table of Contents

Class SMPTEVideoEffect

Namespace
VisioForge.Core.Types.X.VideoEffects
Assembly
VisioForge.Core.dll

Represents a SMPTE (Society of Motion Picture and Television Engineers) transition effect that creates professional wipe transitions between two video sources.

public class SMPTEVideoEffect : BaseVideoEffect, IBaseVideoEffect, IVideoEditXVideoEffect

Inheritance

Implements

Inherited Members

Remarks

SDK Availability: VideoCaptureCoreX, MediaPlayerCoreX, VideoEditCoreX, Media Blocks SDK

Platforms: Windows, Linux, macOS, Android, iOS

This effect implements standard SMPTE transition patterns used in professional video editing, providing a wide variety of wipe transitions between two video sources. SMPTE transitions are industry-standard effects that create geometric patterns to reveal one video while concealing another.

The SMPTE effect supports numerous transition patterns including:

  • Linear Wipes: Horizontal, vertical, and diagonal wipes in all directions
  • Box Wipes: Rectangular and square patterns expanding or contracting
  • Iris Effects: Circular and shaped iris opens and closes
  • Clock Wipes: Radial sweeps like a clock hand
  • Diagonal Wipes: Multi-directional diagonal patterns
  • Special Patterns: Hearts, diamonds, and other shapes

The SMPTE effect is commonly used for:

  • Scene Transitions: Professional transitions between video clips
  • Picture-in-Picture: Revealing secondary video sources
  • Broadcast Graphics: News and sports transition effects
  • Video Editing: Standard editing transitions in professional workflows
  • Live Production: Real-time switching between camera sources

The effect is controlled by the VisioForge.Core.Types.X.VideoEffects.SMPTEVideoEffect.Depth parameter which animates from 0.0 (showing first input) to 1.0 (showing second input). The VisioForge.Core.Types.X.VideoEffects.SMPTEVideoEffect.Type parameter selects from 256+ standard SMPTE patterns defined by VisioForge.Core.Types.X.VideoEffects.SMPTETransitionType. Optional border highlighting and direction inversion provide additional customization.

This is a cross-platform effect using the smpte element. The effect requires two video inputs (typically configured in a video mixer or compositor).

Performance: Real-time capable on all platforms. GPU-accelerated where available. Minimal CPU overhead. Suitable for live production and editing workflows.

Constructors

SMPTEVideoEffect(string)

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.SMPTEVideoEffect class with specified name.

public SMPTEVideoEffect(string name = "smpte")

Parameters

name string

The unique name for this effect instance. Defaults to "smpte".

Fields

DefaultName

The default name for SMPTE transition effects.

public static string DefaultName

Field Value

string

Properties

Border

Gets or sets the border width in pixels for the transition edge.

public int Border { get; set; }

Property Value

int

Remarks

A non-zero border value creates a visible border line around the transition edge, making the wipe more prominent. The border appears between the two video sources during the transition. Larger values create thicker, more visible borders.

Depth

Gets or sets the transition depth controlling the progress of the wipe.

public double Depth { get; set; }

Property Value

double

Remarks

The depth parameter animates the transition. Gradually increasing depth from 0.0 to 1.0 creates a smooth wipe from the first video to the second. The rate of change determines the transition speed. For a 1-second transition at 30fps, increment depth by ~0.033 per frame.

Invert

Gets or sets whether to invert the transition direction.

public bool Invert { get; set; }

Property Value

bool

Remarks

When inverted, the transition reveals the second video from the opposite direction. For example, a left-to-right wipe becomes a right-to-left wipe. This provides additional variation without requiring separate transition types.

StartTime

Gets or sets the start time for the SMPTE effect (VideoEditCoreX only).

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

Remarks

This property is only used in VideoEditCoreX for time-based effect control.

StopTime

Gets or sets the stop time for the SMPTE effect (VideoEditCoreX only).

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

Remarks

This property is only used in VideoEditCoreX for time-based effect control.

Type

Gets or sets the SMPTE transition pattern type.

public SMPTETransitionType Type { get; set; }

Property Value

SMPTETransitionType

Remarks

The transition type defines the geometric pattern used for the wipe. Each pattern is defined by SMPTE standards and numbered for consistency across video editing platforms. See the VisioForge.Core.Types.X.VideoEffects.SMPTETransitionType documentation for the complete list of available patterns.

Methods

GenerateDescription()

Generates the description.

public string GenerateDescription()

Returns

string

A string containing the GStreamer element description for the SMPTE effect.