Class VideoEffectTextLogo

Text logo.

Inheritance

object

VideoEffect

VideoEffectTextLogo

Implements

IVideoEffectTextLogo

IVideoEffect

IDisposable

Inherited Members

VideoEffect.StartTime

VideoEffect.StopTime

VideoEffect.Name

VideoEffect.Enabled

VideoEffect.Stream

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VisioForge.Core.Types.VideoEffects

Assembly: VisioForge.Core.dll

Syntax

public class VideoEffectTextLogo : VideoEffect, IVideoEffectTextLogo, IVideoEffect, IDisposable

Constructors

VideoEffectTextLogo(bool, string, TimeSpan, TimeSpan)

Initializes a new instance of the VideoEffectTextLogo class.

Declaration

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

Parameters

Type	Name	Description
bool	enabled	True to enable effects.
string	name	Effect name. Can be used to get effect interface to control it.
TimeSpan	startTime	Start time. Use 0 to show effect always.
TimeSpan	stopTime	Stop time. Use 0 to show effect always.

Properties

Antialiasing

Gets or sets antialiasing mode.

Declaration

public TextRenderingHint Antialiasing { get; set; }

Property Value

Type	Description
TextRenderingHint

BackgroundColor

Gets or sets background color.

Declaration

public Color BackgroundColor { get; set; }

Property Value

Type	Description
Color

BackgroundTransparent

Gets or sets a value indicating whether transparent background will be used.

Declaration

public bool BackgroundTransparent { get; set; }

Property Value

Type	Description
bool

BorderInnerColor

Gets or sets inner border color.

Declaration

public Color BorderInnerColor { get; set; }

Property Value

Type	Description
Color

BorderInnerSize

Gets or sets inner border size.

Declaration

public int BorderInnerSize { get; set; }

Property Value

Type	Description
int

BorderMode

Gets or sets border mode.

Declaration

public TextEffectMode BorderMode { get; set; }

Property Value

Type	Description
TextEffectMode

BorderOuterColor

Gets or sets outer border color.

Declaration

public Color BorderOuterColor { get; set; }

Property Value

Type	Description
Color

BorderOuterSize

Gets or sets outer border size.

Declaration

public int BorderOuterSize { get; set; }

Property Value

Type	Description
int

DateTimeMask

Gets or sets date mask.

Declaration

public string DateTimeMask { get; set; }

Property Value

Type	Description
string

Remarks

You can use mask like this: "MM.dd.yyyy hh:mm:ss". Mask based on the following specifications: http://msdn.microsoft.com/en-us/library/dd317787(v=VS.85).aspx and http://msdn.microsoft.com/en-us/library/dd318148(v=VS.85).aspx .

DrawQuality

Gets or sets draw quality.

Declaration

public InterpolationMode DrawQuality { get; set; }

Property Value

Type	Description
InterpolationMode

FadeIn

Gets or sets a value indicating whether fade-in enabled.

Declaration

public bool FadeIn { get; set; }

Property Value

Type	Description
bool

FadeInDuration

Gets or sets fade-in duration.

Declaration

public TimeSpan FadeInDuration { get; set; }

Property Value

Type	Description
TimeSpan

FadeOut

Gets or sets a value indicating whether fade-out enabled.

Declaration

public bool FadeOut { get; set; }

Property Value

Type	Description
bool

FadeOutDuration

Gets or sets fade-out duration.

Declaration

public TimeSpan FadeOutDuration { get; set; }

Property Value

Type	Description
TimeSpan

FlipMode

Gets or sets flip mode.

Declaration

public TextFlipMode FlipMode { get; set; }

Property Value

Type	Description
TextFlipMode

Font

Gets or sets font.

Declaration

public Font Font { get; set; }

Property Value

Type	Description
Font

FontColor

Gets or sets font color.

Declaration

public Color FontColor { get; set; }

Property Value

Type	Description
Color

GradientColor1

Gets or sets gradient color 1.

Declaration

public Color GradientColor1 { get; set; }

Property Value

Type	Description
Color

GradientColor2

Gets or sets gradient color 2.

Declaration

public Color GradientColor2 { get; set; }

Property Value

Type	Description
Color

GradientEnabled

Gets or sets a value indicating whether gradient will be used.

Declaration

public bool GradientEnabled { get; set; }

Property Value

Type	Description
bool

GradientMode

Gets or sets gradient mode.

Declaration

public TextGradientMode GradientMode { get; set; }

Property Value

Type	Description
TextGradientMode

HorizontalAlignment

Gets or sets the horizontal alignment.

Declaration

public TextLogoHorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
TextLogoHorizontalAlignment

Left

Gets or sets X position.

Declaration

public int Left { get; set; }

Property Value

Type	Description
int

Mode

Gets or sets mode.

Declaration

public TextLogoMode Mode { get; set; }

Property Value

Type	Description
TextLogoMode

NeedUpdate

Gets or sets a value indicating whether data update required.

Declaration

public bool NeedUpdate { get; set; }

Property Value

Type	Description
bool

RectHeight

Gets or sets rectangle (around the text) height.

Declaration

public int RectHeight { get; set; }

Property Value

Type	Description
int

RectWidth

Gets or sets rectangle (around the text) width.

Declaration

public int RectWidth { get; set; }

Property Value

Type	Description
int

RotationMode

Gets or sets rotation mode.

Declaration

public TextRotationMode RotationMode { get; set; }

Property Value

Type	Description
TextRotationMode

Shape

Gets or sets a value indicating whether use background shape.

Declaration

public bool Shape { get; set; }

Property Value

Type	Description
bool

ShapeColor

Gets or sets background shape color.

Declaration

public Color ShapeColor { get; set; }

Property Value

Type	Description
Color

ShapeHeight

Gets or sets background shape height.

Declaration

public int ShapeHeight { get; set; }

Property Value

Type	Description
int

ShapeLeft

Gets or sets background shape X.

Declaration

public int ShapeLeft { get; set; }

Property Value

Type	Description
int

ShapeTop

Gets or sets background shape Y.

Declaration

public int ShapeTop { get; set; }

Property Value

Type	Description
int

ShapeType

Gets or sets background shape type.

Declaration

public TextShapeType ShapeType { get; set; }

Property Value

Type	Description
TextShapeType

ShapeWidth

Gets or sets background shape width.

Declaration

public int ShapeWidth { get; set; }

Property Value

Type	Description
int

StringFormat

Gets or sets string format.

Declaration

public StringFormat StringFormat { get; set; }

Property Value

Type	Description
StringFormat

Text

Gets or sets text.

Declaration

public string Text { get; set; }

Property Value

Type	Description
string

TimeStampMask

Gets or sets timestamp mask.

Declaration

public string TimeStampMask { get; set; }

Property Value

Type	Description
string

Remarks

You can use mask like this: "hh:mm:ss". Mask based on the following specifications: http://msdn.microsoft.com/en-us/library/dd317787(v=VS.85).aspx and http://msdn.microsoft.com/en-us/library/dd318148(v=VS.85).aspx .

Top

Gets or sets Y position.

Declaration

public int Top { get; set; }

Property Value

Type	Description
int

TransparencyLevel

Gets or sets transparency level. Range is 0-255.

Declaration

public int TransparencyLevel { get; set; }

Property Value

Type	Description
int

VerticalAlignment

Gets or sets the vertical alignment.

Declaration

public TextLogoVerticalAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
TextLogoVerticalAlignment

Methods

Dispose()

This code added to correctly implement the disposable pattern.

Declaration

public void Dispose()

Dispose(bool)

Dispose.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	The disposing.

~VideoEffectTextLogo()

Finalizes an instance of the VideoEffectTextLogo class.

Declaration

protected ~VideoEffectTextLogo()

GetEffectType()

Gets type.

Declaration

public VideoEffectType GetEffectType()

Returns

Type	Description
VideoEffectType	The VideoEffectType.

Update()

Updates effect settings. Call it if something changed.

Declaration

public void Update()

Implements

IVideoEffectTextLogo

IVideoEffect

IDisposable