Class VideoEffectScrollingTextLogo

Scrolling text logo.

Inheritance

object

VideoEffect

VideoEffectScrollingTextLogo

Implements

IVideoEffectScrollingTextLogo

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 VideoEffectScrollingTextLogo : VideoEffect, IVideoEffectScrollingTextLogo, IVideoEffect, IDisposable

Constructors

VideoEffectScrollingTextLogo(bool, string, TimeSpan, TimeSpan)

Initializes a new instance of the VideoEffectScrollingTextLogo class.

Declaration

public VideoEffectScrollingTextLogo(bool enabled, string name = "ScrollingTextLogo", 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

Bitmap

Gets or sets bitmap buffer.

Declaration

public nint Bitmap { get; set; }

Property Value

Type	Description
nint

BitmapHeight

Gets or sets bitmap height.

Declaration

public int BitmapHeight { get; set; }

Property Value

Type	Description
int

BitmapWidth

Gets or sets bitmap width.

Declaration

public int BitmapWidth { get; set; }

Property Value

Type	Description
int

DrawQuality

Gets or sets draw quality.

Declaration

public InterpolationMode DrawQuality { get; set; }

Property Value

Type	Description
InterpolationMode

FirstFrameNumber

Gets or sets the first frame number. If -1 then first frame will be used.

Declaration

public long FirstFrameNumber { get; set; }

Property Value

Type	Description
long	The first frame number.

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

Infinite

Gets or sets a value indicating whether scrolling text should start from beginning if over.

Declaration

public bool Infinite { get; set; }

Property Value

Type	Description
bool	true if infinite; otherwise, false.

Left

Gets or sets X position.

Declaration

public int Left { get; set; }

Property Value

Type	Description
int

NeedUpdate

Gets or sets a value indicating whether data update required.

Declaration

public bool NeedUpdate { get; set; }

Property Value

Type	Description
bool

Speed

Gets or sets the speed.

Declaration

public int Speed { 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

TextRestarted

Gets or sets the text restarted delegate.

Declaration

public Delegate TextRestarted { get; set; }

Property Value

Type	Description
Delegate	The text restarted.

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

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.

~VideoEffectScrollingTextLogo()

Finalizes an instance of the VideoEffectScrollingTextLogo class.

Declaration

protected ~VideoEffectScrollingTextLogo()

GetEffectType()

Gets type.

Declaration

public VideoEffectType GetEffectType()

Returns

Type	Description
VideoEffectType	The VideoEffectType.

Preload(int, int, int)

Preloads the specified scrolling text overlay. You can use this API to preload scrolling text overlay before starting playback and prevent delay on the first video frame.

Declaration

public void Preload(int frameWidth, int frameHeight, int frameStride)

Parameters

Type	Name	Description
int	frameWidth	Width of the video frame.
int	frameHeight	Height of the video frame.
int	frameStride

Reset()

Resets.

Declaration

public void Reset()

Update()

Updates effect settings. Call it if something changed.

Declaration

public void Update()

Implements

IVideoEffectScrollingTextLogo

IVideoEffect

IDisposable