Table of Contents

Class TextStatusOverlay

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

Represents a status overlay that displays text on top of the video stream.

public class TextStatusOverlay : IStatusOverlay

Inheritance

Implements

Inherited Members

Examples

// To create a text overlay with custom message and color:
var textOverlay = new TextStatusOverlay
{
    TextConnecting = "Loading Video...",
    Font = new Font("Arial", 36, FontStyle.Italic),
    Brush = new SolidBrush(Color.Yellow),
    VerticalAlignment = VisioForge.Core.Types.VideoProcessing.VerticalAlignment.Top,
    HorizontalAlignment = VisioForge.Core.Types.VideoProcessing.HorizontalAlignment.Left
};

// This overlay can then be added to the video pipeline.

Remarks

This class allows you to display dynamic text messages, such as "Connecting..." or "Buffering...", directly on the video output. You can customize the text, font, color, and alignment.

Constructors

TextStatusOverlay()

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

public TextStatusOverlay()

Remarks

By default, the text is "Connecting...", centered both horizontally and vertically, with a white, bold, 24pt monospace font.

Properties

Brush

Gets or sets the brush used for painting the text overlay.

public Brush Brush { get; set; }

Property Value

Brush

Font

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

public Font Font { get; set; }

Property Value

Font

HorizontalAlignment

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

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

HorizontalAlignment

StringFormat

Gets or sets the VisioForge.Core.Types.TextStatusOverlay.StringFormat object that encapsulates text layout information.

public StringFormat StringFormat { get; set; }

Property Value

StringFormat

TextConnecting

Gets or sets the text to be displayed when the component is in a "connecting" state.

public string TextConnecting { get; set; }

Property Value

string

VerticalAlignment

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

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

VerticalAlignment