Class VideoEffectImageLogo

Image logo effect.

Inheritance

object

VideoEffect

VideoEffectImageLogo

Implements

IVideoEffectImageLogo

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 VideoEffectImageLogo : VideoEffect, IVideoEffectImageLogo, IVideoEffect, IDisposable

Constructors

VideoEffectImageLogo(bool, string, TimeSpan, TimeSpan)

Initializes a new instance of the VideoEffectImageLogo class.

Declaration

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

Animated

Gets or sets a value indicating whether image animated.

Declaration

public bool Animated { get; set; }

Property Value

Type	Description
bool

AnimationEnabled

Gets or sets a value indicating whether animation enabled.

Declaration

public bool AnimationEnabled { get; set; }

Property Value

Type	Description
bool

Bitmap

Gets or sets bitmap buffer.

Declaration

public nint Bitmap { get; set; }

Property Value

Type	Description
nint

BitmapDepth

Gets or sets bitmap depth. 3 for RGB24, 4 for RGB32.

Declaration

public int BitmapDepth { get; set; }

Property Value

Type	Description
int

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

ColorKey

Gets or sets color key.

Declaration

public Color ColorKey { get; set; }

Property Value

Type	Description
Color

Filename

Gets or sets file name.

Declaration

public string Filename { get; set; }

Property Value

Type	Description
string

GIFImage

Gets or sets GIF image object.

Declaration

public object GIFImage { get; set; }

Property Value

Type	Description
object

HorizontalAlignment

Gets or sets the horizontal alignment.

Declaration

public ImageLogoHorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
ImageLogoHorizontalAlignment

Left

Gets or sets X coordinate.

Declaration

public uint Left { get; set; }

Property Value

Type	Description
uint

MemoryBitmap

Gets or sets bitmap from memory.

Declaration

public Bitmap MemoryBitmap { get; set; }

Property Value

Type	Description
Bitmap

StretchMode

Gets or sets stretch mode.

Declaration

public VideoEffectStretchMode StretchMode { get; set; }

Property Value

Type	Description
VideoEffectStretchMode

Top

Gets or sets Y coordinate.

Declaration

public uint Top { get; set; }

Property Value

Type	Description
uint

TransparencyLevel

Gets or sets transparency level [0..255].

Declaration

public int TransparencyLevel { get; set; }

Property Value

Type	Description
int

UseColorKey

Gets or sets a value indicating whether color key enabled.

Declaration

public bool UseColorKey { get; set; }

Property Value

Type	Description
bool

VerticalAlignment

Gets or sets the vertical alignment.

Declaration

public ImageLogoVerticalAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
ImageLogoVerticalAlignment

Methods

Dispose()

The dispose.

Declaration

public void Dispose()

Dispose(bool)

The dispose.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	The disposing.

~VideoEffectImageLogo()

Finalizes an instance of the VideoEffectImageLogo class.

Declaration

protected ~VideoEffectImageLogo()

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

IVideoEffectImageLogo

IVideoEffect

IDisposable