Table of Contents

Class VideoEffectTextLogo

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

Renders text overlays on video frames with extensive customization options including fonts, colors, borders, gradients, shapes, transparency, and animation effects.

public class VideoEffectTextLogo : VideoEffect, IVideoEffectTextLogo, IVideoEffect, IDisposable

Inheritance

Implements

Inherited Members

Remarks

SDK Availability:

  • VideoCaptureCore SDK - Windows only
  • MediaPlayerCore SDK - Windows only
  • VideoEditCore SDK - Windows only

Platform Support: Windows only (requires GDI+ for text rendering)

Effect Behavior:

The VideoEffectTextLogo effect overlays text on video frames with sophisticated rendering capabilities. It supports multiple text modes including static text, date/time display, timestamp, and frame number display. The effect provides extensive visual customization through fonts, colors, transparency, borders, gradients, and background shapes.

Key Features:

  • Multiple Display Modes: Static text, date/time with custom format masks, playback timestamp, or frame numbers
  • Font Customization: Full font control with color, size, style, and text rendering quality (antialiasing)
  • Positioning: Absolute pixel positioning or automatic alignment (top/center/bottom, left/center/right)
  • Visual Effects: Text rotation (0°, 90°, 180°, 270°), flipping (horizontal/vertical), transparency levels
  • Borders and Outlines: Multiple border modes including inner/outer borders, embossed, outline, filled outline, and halo effects
  • Gradients: Linear gradients in horizontal, vertical, or diagonal directions with customizable colors
  • Background Shapes: Optional rectangular or elliptical background shapes with custom colors and positioning
  • Animation: Fade-in and fade-out transitions with configurable durations
  • Dynamic Updates: Text and properties can be updated during playback using the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Update method

Use Cases:

  • Video watermarking with company names or logos
  • Timestamp overlays for security or surveillance footage
  • Frame number display for video editing and debugging
  • Date/time stamps on recorded videos
  • Dynamic text notifications or status messages
  • Subtitle or caption rendering (though dedicated subtitle effects may be more appropriate)

Technical Details:

The effect uses GDI+ for high-quality text rendering with antialiasing support. Text is rendered to an internal bitmap buffer that is then composited onto video frames. The effect supports transparency through both alpha blending and transparent backgrounds. Gradient rendering uses System.Drawing.Drawing2D.LinearGradientBrush for smooth color transitions. Border effects are achieved through multiple text rendering passes with offset positioning.

For dynamic text updates during playback, modify the text or other properties and call VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Update to trigger re-rendering. The effect respects the VisioForge.Core.Types.VideoEffects.VideoEffect.StartTime and VisioForge.Core.Types.VideoEffects.VideoEffect.StopTime properties for timed overlays. When VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Mode is set to DateTime or Timestamp, the display updates automatically based on playback time.

Constructors

VideoEffectTextLogo(bool, string, TimeSpan, TimeSpan)

Initializes a new instance of the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo class with default settings.

public VideoEffectTextLogo(bool enabled, string name = "TextLogo", TimeSpan startTime = default, TimeSpan stopTime = default)

Parameters

enabled bool

true to enable the effect immediately; false to create the effect in a disabled state. The effect can be enabled later by setting VisioForge.Core.Types.VideoEffects.VideoEffect.Enabled to true.

name string

A unique name for this effect instance. This name can be used to retrieve the effect interface for dynamic control during playback. Default is "TextLogo".

startTime TimeSpan

The playback position at which this effect should begin displaying. Use Zero (default) to display the effect from the beginning of the video. The effect will not be visible before this time even if enabled is true.

stopTime TimeSpan

The playback position at which this effect should stop displaying. Use Zero (default) to display the effect until the end of the video. When set to a specific time, the effect will automatically hide after that playback position is reached.

Remarks

The constructor initializes the effect with sensible defaults:

  • Font: Arial 36pt
  • Position: (0, 0) top-left corner
  • Font color: White
  • Background: Transparent
  • Text: "Hello!!!"
  • Mode: Static text (VisioForge.Core.Types.VideoEffects.TextLogoMode.Text)
  • Draw quality: High quality bicubic interpolation
  • Antialiasing: Enabled (AntiAlias mode)
  • Alignment: Custom (use VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Left and VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Top coordinates)
All visual properties can be modified after construction. Call VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Update after making changes to apply them.

Properties

Antialiasing

Gets or sets the text antialiasing mode for smooth text rendering.

public TextRenderingHint Antialiasing { get; set; }

Property Value

TextRenderingHint

Remarks

Antialiasing smooths the edges of rendered text to reduce jagged appearance on screen. Common values include:

For video overlays, AntiAlias or ClearTypeGridFit typically provide the best visual results.

BackgroundColor

Gets or sets the background color behind the text.

public Color BackgroundColor { get; set; }

Property Value

Color

Remarks

This color is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BackgroundTransparent is set to false. The background is drawn as a rectangle encompassing the text bounds before the text is rendered. This is separate from the optional background VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Shape which can be positioned independently.

BackgroundTransparent

Gets or sets a value indicating whether the text background should be transparent.

public bool BackgroundTransparent { get; set; }

Property Value

bool

Remarks

When set to true, only the text itself is rendered, allowing the underlying video to show through. When set to false, a rectangular background is drawn using VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BackgroundColor before rendering the text. This is independent of the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Shape property which controls additional background shapes.

BorderInnerColor

Gets or sets the color of the inner border.

public Color BorderInnerColor { get; set; }

Property Value

Color

Remarks

This property is used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderMode includes inner border effects (Inner, InnerAndOuter modes). The inner border is drawn inside the text outline with the size specified by VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderInnerSize.

BorderInnerSize

Gets or sets the thickness of the inner border in pixels.

public int BorderInnerSize { get; set; }

Property Value

int

Remarks

This property controls the thickness of the inner border when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderMode includes inner border effects. Larger values create thicker borders but may affect text readability if too large relative to the font size. A value of 0 disables the inner border regardless of VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderMode.

BorderMode

Gets or sets the border/outline effect style applied to the text.

public TextEffectMode BorderMode { get; set; }

Property Value

TextEffectMode

Remarks

Text borders enhance readability by creating contrast between the text and the video background. Available border modes include:

  • VisioForge.Core.Types.VideoEffects.TextEffectMode.None - No border effect
  • VisioForge.Core.Types.VideoEffects.TextEffectMode.Inner - Border drawn inside the text outline using VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderInnerColor and VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderInnerSize
  • VisioForge.Core.Types.VideoEffects.TextEffectMode.Outer - Border drawn outside the text outline using VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderOuterColor and VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderOuterSize
  • VisioForge.Core.Types.VideoEffects.TextEffectMode.InnerAndOuter - Both inner and outer borders applied
  • VisioForge.Core.Types.VideoEffects.TextEffectMode.Embossed - 3D embossed effect
  • VisioForge.Core.Types.VideoEffects.TextEffectMode.Outline - Simple outline effect
  • VisioForge.Core.Types.VideoEffects.TextEffectMode.FilledOutline - Outlined text with filled center
  • VisioForge.Core.Types.VideoEffects.TextEffectMode.Halo - Glow/halo effect around text
Border effects are particularly useful for ensuring text readability over varying video backgrounds.

BorderOuterColor

Gets or sets the color of the outer border.

public Color BorderOuterColor { get; set; }

Property Value

Color

Remarks

This property is used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderMode includes outer border effects (Outer, InnerAndOuter, Outline, FilledOutline, Halo modes). The outer border is drawn outside the text outline with the size specified by VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderOuterSize. Black outer borders are commonly used to ensure text readability on light backgrounds.

BorderOuterSize

Gets or sets the thickness of the outer border in pixels.

public int BorderOuterSize { get; set; }

Property Value

int

Remarks

This property controls the thickness of the outer border when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderMode includes outer border effects. Outer borders are effective for creating strong contrast against dark backgrounds. A value of 0 disables the outer border regardless of VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BorderMode. For halo effects, larger values create more prominent glows around the text.

DateTimeMask

Gets or sets the format string for displaying date and time information.

public string DateTimeMask { get; set; }

Property Value

string

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Mode is set to VisioForge.Core.Types.VideoEffects.TextLogoMode.DateTime. The mask follows standard .NET DateTime format patterns as documented at:

http://msdn.microsoft.com/en-us/library/dd317787(v=VS.85).aspx

http://msdn.microsoft.com/en-us/library/dd318148(v=VS.85).aspx

Common format specifiers:

  • MM - Month as two digits (01-12)
  • dd - Day as two digits (01-31)
  • yyyy - Year as four digits
  • hh - Hour in 12-hour format (01-12)
  • HH - Hour in 24-hour format (00-23)
  • mm - Minutes (00-59)
  • ss - Seconds (00-59)
  • tt - AM/PM designator
Example masks: "yyyy-MM-dd HH:mm:ss", "dddd, MMMM dd, yyyy", "MM/dd/yy hh:mm tt"

DrawQuality

Gets or sets the interpolation mode used for graphics rendering quality.

public InterpolationMode DrawQuality { get; set; }

Property Value

InterpolationMode

Remarks

The interpolation mode affects the quality of graphics rendering, particularly when scaling or transforming the text overlay. HighQualityBicubic provides the best quality at the cost of performance. NearestNeighbor is fastest but lowest quality. For most text overlays, high-quality modes are recommended for smooth, professional appearance.

FadeIn

Gets or sets a value indicating whether the text overlay should fade in when it first appears.

public bool FadeIn { get; set; }

Property Value

bool

Remarks

When enabled, the overlay gradually transitions from fully transparent to the specified opacity over the duration defined by VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.FadeInDuration. The fade-in begins at the VisioForge.Core.Types.VideoEffects.VideoEffect.StartTime or when the effect is first enabled. Fade-in effects create a professional, smooth appearance for overlay transitions.

FadeInDuration

Gets or sets the duration of the fade-in animation.

public TimeSpan FadeInDuration { get; set; }

Property Value

TimeSpan

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.FadeIn is true. Typical values range from 0.5 to 3 seconds depending on the desired effect. Longer durations create gentler, more subtle transitions while shorter durations are more noticeable. The transparency level transitions linearly from 255 (fully transparent) to the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.TransparencyLevel value over this duration.

FadeOut

Gets or sets a value indicating whether the text overlay should fade out before it disappears.

public bool FadeOut { get; set; }

Property Value

bool

Remarks

When enabled, the overlay gradually transitions from the current opacity to fully transparent over the duration defined by VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.FadeOutDuration. The fade-out begins at the VisioForge.Core.Types.VideoEffects.VideoEffect.StopTime minus VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.FadeOutDuration, or when the effect is disabled. Fade-out effects prevent abrupt disappearance of overlays, maintaining a polished appearance.

FadeOutDuration

Gets or sets the duration of the fade-out animation.

public TimeSpan FadeOutDuration { get; set; }

Property Value

TimeSpan

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.FadeOut is true. Typical values range from 0.5 to 3 seconds. The fade-out begins before the VisioForge.Core.Types.VideoEffects.VideoEffect.StopTime so that the overlay is fully transparent by the stop time. The transparency level transitions linearly from the current VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.TransparencyLevel value to 255 (fully transparent) over this duration.

FlipMode

Gets or sets the flip/mirror mode applied to the text overlay.

public TextFlipMode FlipMode { get; set; }

Property Value

TextFlipMode

Remarks

Flipping creates a mirror image of the text. Available modes are:

  • VisioForge.Core.Types.VideoEffects.TextFlipMode.None - No flipping
  • VisioForge.Core.Types.VideoEffects.TextFlipMode.X - Horizontal flip (mirror left-right)
  • VisioForge.Core.Types.VideoEffects.TextFlipMode.Y - Vertical flip (mirror top-bottom)
  • VisioForge.Core.Types.VideoEffects.TextFlipMode.XAndY - Both horizontal and vertical flip (180° rotation equivalent)
Flipping is applied after rotation, so both effects can be combined for creative text presentations.

Font

Gets or sets the font used for rendering the text overlay.

public Font Font { get; set; }

Property Value

Font

Remarks

The font determines the appearance, size, and style (bold, italic, etc.) of the rendered text. The font object is cloned when set to ensure the internal state is not affected by external changes. Remember to dispose the font object if you create it manually, as the effect maintains its own copy.

FontColor

Gets or sets the color of the rendered text.

public Color FontColor { get; set; }

Property Value

Color

Remarks

This color is used for the main text rendering. If VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientEnabled is true, this property is ignored and the gradient colors are used instead. The color supports full ARGB values including alpha transparency, though the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.TransparencyLevel property provides an additional way to control text opacity.

GradientColor1

Gets or sets the starting color of the gradient.

public Color GradientColor1 { get; set; }

Property Value

Color

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientEnabled is true. The gradient transitions from this color to VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientColor2 in the direction specified by VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientMode.

GradientColor2

Gets or sets the ending color of the gradient.

public Color GradientColor2 { get; set; }

Property Value

Color

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientEnabled is true. The gradient transitions from VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientColor1 to this color in the direction specified by VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientMode.

GradientEnabled

Gets or sets a value indicating whether gradient fill should be used for the text instead of solid color.

public bool GradientEnabled { get; set; }

Property Value

bool

Remarks

When enabled, the text is filled with a linear gradient from VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientColor1 to VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientColor2 in the direction specified by VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientMode. When disabled, the text uses the solid VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.FontColor. Gradients can create visually appealing text effects and improve readability against varying backgrounds.

GradientMode

Gets or sets the direction of the gradient fill.

public TextGradientMode GradientMode { get; set; }

Property Value

TextGradientMode

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.GradientEnabled is true. Available modes are:

  • VisioForge.Core.Types.VideoEffects.TextGradientMode.Horizontal - Left to right gradient
  • VisioForge.Core.Types.VideoEffects.TextGradientMode.Vertical - Top to bottom gradient
  • VisioForge.Core.Types.VideoEffects.TextGradientMode.ForwardDiagonal - Upper-left to lower-right diagonal
  • VisioForge.Core.Types.VideoEffects.TextGradientMode.BackwardDiagonal - Upper-right to lower-left diagonal

HorizontalAlignment

Gets or sets the horizontal alignment of the text overlay within the video frame.

public TextLogoHorizontalAlignment HorizontalAlignment { get; set; }

Property Value

TextLogoHorizontalAlignment

Remarks

Controls automatic horizontal positioning of the text overlay. Available options:

  • VisioForge.Core.Types.VideoEffects.TextLogoHorizontalAlignment.Custom - Use the explicit VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Left coordinate
  • VisioForge.Core.Types.VideoEffects.TextLogoHorizontalAlignment.Left - Align to the left edge of the video frame
  • VisioForge.Core.Types.VideoEffects.TextLogoHorizontalAlignment.Center - Center horizontally in the video frame
  • VisioForge.Core.Types.VideoEffects.TextLogoHorizontalAlignment.Right - Align to the right edge of the video frame
When set to anything other than Custom, the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Left property is ignored. Automatic alignment simplifies positioning text at standard locations (e.g., centered titles, right-aligned timestamps).

Left

Gets or sets the X coordinate (horizontal position) of the text overlay in pixels from the left edge of the video frame.

public int Left { get; set; }

Property Value

int

Remarks

When using automatic horizontal alignment (VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.HorizontalAlignment set to Left, Center, or Right), this property is ignored. The position applies to the top-left corner of the rendered text bounding box.

Mode

Gets or sets the display mode that determines what content is shown in the overlay.

public TextLogoMode Mode { get; set; }

Property Value

TextLogoMode

Remarks

This property controls the source of the displayed text:

  • VisioForge.Core.Types.VideoEffects.TextLogoMode.Text - Displays the static text from the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Text property
  • VisioForge.Core.Types.VideoEffects.TextLogoMode.DateTime - Displays the current date and time formatted according to VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.DateTimeMask
  • VisioForge.Core.Types.VideoEffects.TextLogoMode.Timestamp - Displays the playback position/timestamp formatted according to VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.TimeStampMask
  • VisioForge.Core.Types.VideoEffects.TextLogoMode.FrameNumber - Displays the current video frame number
For DateTime and Timestamp modes, the display updates automatically as playback progresses.

NeedUpdate

Gets or sets a value indicating whether data update required.

public bool NeedUpdate { get; set; }

Property Value

bool

RectHeight

Gets or sets the height of the text bounding rectangle in pixels.

public int RectHeight { get; set; }

Property Value

int

Remarks

When set to 0, the rectangle height is automatically calculated based on the text content, font, and number of lines. When set to a positive value, the text is constrained to fit within this height. This property works in conjunction with VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.RectWidth to define the text layout area.

RectWidth

Gets or sets the width of the text bounding rectangle in pixels.

public int RectWidth { get; set; }

Property Value

int

Remarks

When set to 0, the rectangle width is automatically calculated based on the text content and font. When set to a positive value, the text is constrained to fit within this width, potentially wrapping to multiple lines. This property is useful for creating fixed-width text areas or controlling text layout.

RotationMode

Gets or sets the rotation angle applied to the text overlay.

public TextRotationMode RotationMode { get; set; }

Property Value

TextRotationMode

Remarks

Rotation is applied around the center of the text bounding box. Available rotations are:

  • VisioForge.Core.Types.VideoEffects.TextRotationMode.RmNone - No rotation (0°)
  • VisioForge.Core.Types.VideoEffects.TextRotationMode.Rm90 - 90° clockwise rotation
  • VisioForge.Core.Types.VideoEffects.TextRotationMode.Rm180 - 180° rotation (upside down)
  • VisioForge.Core.Types.VideoEffects.TextRotationMode.Rm270 - 270° clockwise rotation (90° counter-clockwise)
Rotation is applied before positioning, so the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Left and VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Top coordinates refer to the rotated text's position.

Shape

Gets or sets a value indicating whether a background shape should be drawn behind the text.

public bool Shape { get; set; }

Property Value

bool

Remarks

When enabled, a geometric shape (rectangle or ellipse) is drawn at the position specified by VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.ShapeLeft and VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.ShapeTop before rendering the text. The shape dimensions are controlled by VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.ShapeWidth and VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.ShapeHeight. This is useful for creating badges, tags, or ensuring text readability by providing a consistent background regardless of video content. The shape is independent of the text background controlled by VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BackgroundTransparent and VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.BackgroundColor.

ShapeColor

Gets or sets the fill color of the background shape.

public Color ShapeColor { get; set; }

Property Value

Color

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Shape is true. The shape is filled with this solid color. Use semi-transparent colors (with alpha channel) for subtle backgrounds that allow some of the underlying video to show through.

ShapeHeight

Gets or sets the height of the background shape in pixels.

public int ShapeHeight { get; set; }

Property Value

int

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Shape is true. For rectangle shapes, this is the rectangle height. For ellipse shapes, this is the height of the bounding ellipse.

ShapeLeft

Gets or sets the X coordinate of the background shape in pixels.

public int ShapeLeft { get; set; }

Property Value

int

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Shape is true. The shape position is independent of the text position (VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Left, VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Top), allowing you to position the background shape separately from the text for creative layouts.

ShapeTop

Gets or sets the Y coordinate of the background shape in pixels.

public int ShapeTop { get; set; }

Property Value

int

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Shape is true. The shape position is independent of the text position, allowing flexible layout designs.

ShapeType

Gets or sets the type of background shape to draw.

public TextShapeType ShapeType { get; set; }

Property Value

TextShapeType

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Shape is true. Available shape types:

  • VisioForge.Core.Types.VideoEffects.TextShapeType.Rectangle - Rectangular background shape
  • VisioForge.Core.Types.VideoEffects.TextShapeType.Ellipse - Elliptical/circular background shape
Rectangle shapes are common for badges or tags, while ellipse shapes can create softer, more organic appearances.

ShapeWidth

Gets or sets the width of the background shape in pixels.

public int ShapeWidth { get; set; }

Property Value

int

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Shape is true. For rectangle shapes, this is the rectangle width. For ellipse shapes, this is the width of the bounding ellipse. Ensure the shape is large enough to provide adequate background for the text overlay.

StringFormat

Gets or sets the string formatting options for text layout and rendering.

public StringFormat StringFormat { get; set; }

Property Value

StringFormat

Remarks

The StringFormat controls how text is laid out within its bounding rectangle, including alignment (near, center, far), line alignment, text direction, trimming behavior, and character formatting. If null, the default GDI+ string formatting is used.

Text

Gets or sets the text content to display or the formatting mask for dynamic content.

public string Text { get; set; }

Property Value

string

Remarks

The behavior of this property depends on the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Mode setting:

  • VisioForge.Core.Types.VideoEffects.TextLogoMode.Text - Displays the literal text string
  • VisioForge.Core.Types.VideoEffects.TextLogoMode.DateTime - Ignored; use VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.DateTimeMask to format date/time display
  • VisioForge.Core.Types.VideoEffects.TextLogoMode.Timestamp - Ignored; use VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.TimeStampMask to format timestamp display
  • VisioForge.Core.Types.VideoEffects.TextLogoMode.FrameNumber - Ignored; frame number is displayed automatically
Text can be updated dynamically during playback by modifying this property and calling VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Update.

TimeStampMask

Gets or sets the format string for displaying playback timestamp information.

public string TimeStampMask { get; set; }

Property Value

string

Remarks

This property is only used when VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Mode is set to VisioForge.Core.Types.VideoEffects.TextLogoMode.Timestamp. The mask follows TimeSpan format patterns with escaped literal characters. Format specifications at:

http://msdn.microsoft.com/en-us/library/dd317787(v=VS.85).aspx

http://msdn.microsoft.com/en-us/library/dd318148(v=VS.85).aspx

Common format specifiers (use backslash to escape literals):

  • hh - Hours (00-23)
  • mm - Minutes (00-59)
  • ss - Seconds (00-59)
  • fff - Milliseconds (000-999)
  • \: - Literal colon character
  • \. - Literal period/dot character
Example masks: @"mm\:ss", @"hh\:mm\:ss", @"ss\.fff" The timestamp displays the current playback position from the start of the video.

Top

Gets or sets the Y coordinate (vertical position) of the text overlay in pixels from the top edge of the video frame.

public int Top { get; set; }

Property Value

int

Remarks

When using automatic vertical alignment (VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.VerticalAlignment set to Top, Center, or Bottom), this property is ignored. The position applies to the top-left corner of the rendered text bounding box.

TransparencyLevel

Gets or sets the transparency level (alpha channel value) of the entire text overlay.

public int TransparencyLevel { get; set; }

Property Value

int

Remarks

This transparency level is applied to the entire rendered text overlay including text, borders, gradients, and shapes. A value of 0 (default) means no additional transparency is applied beyond what's specified in colors. Values greater than 0 progressively make the overlay more transparent, with 255 making it completely invisible. This provides a convenient way to create subtle overlays or implement fade effects without modifying individual color alpha values. Use in combination with VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.FadeIn and VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.FadeOut for smooth transitions.

VerticalAlignment

Gets or sets the vertical alignment of the text overlay within the video frame.

public TextLogoVerticalAlignment VerticalAlignment { get; set; }

Property Value

TextLogoVerticalAlignment

Remarks

Controls automatic vertical positioning of the text overlay. Available options:

  • VisioForge.Core.Types.VideoEffects.TextLogoVerticalAlignment.Custom - Use the explicit VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Top coordinate
  • VisioForge.Core.Types.VideoEffects.TextLogoVerticalAlignment.Top - Align to the top of the video frame
  • VisioForge.Core.Types.VideoEffects.TextLogoVerticalAlignment.Center - Center vertically in the video frame
  • VisioForge.Core.Types.VideoEffects.TextLogoVerticalAlignment.Bottom - Align to the bottom of the video frame
When set to anything other than Custom, the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Top property is ignored. Automatic alignment is convenient for ensuring text appears at standard positions regardless of video resolution.

Methods

Dispose(bool)

Dispose.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

The disposing.

Dispose()

This code added to correctly implement the disposable pattern.

public void Dispose()

~VideoEffectTextLogo()

Finalizes an instance of the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo class.

protected ~VideoEffectTextLogo()

GetEffectType()

Gets the effect type identifier for this video effect.

public VideoEffectType GetEffectType()

Returns

VideoEffectType

VisioForge.Core.Types.VideoEffects.VideoEffectType.TextLogo identifying this as a text logo overlay effect.

Remarks

This method is used internally by the SDK to identify and process different types of video effects.

Update()

Signals that effect properties have been modified and the overlay should be re-rendered.

public void Update()

Remarks

Call this method after modifying any visual properties of the effect (text, colors, position, font, etc.) to trigger a re-render of the text overlay. This is necessary for dynamic updates during playback.

The method sets an internal flag that causes the effect to regenerate its internal bitmap on the next video frame. This is thread-safe and can be called from any thread.

Example scenario:

To update the displayed text during playback, modify the VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Text property and call VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Update: 
textLogoEffect.Text = "New text content";
textLogoEffect.Update();
Without calling VisioForge.Core.Types.VideoEffects.VideoEffectTextLogo.Update, the text change would not be visible until the effect is reinitialized.

See Also