Class VideoEffectShakeDown

Shake down effect.

Inheritance

object

VideoEffect

VideoEffectShakeDown

Implements

IVideoEffectShakeDown

IVideoEffect

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 VideoEffectShakeDown : VideoEffect, IVideoEffectShakeDown, IVideoEffect

Constructors

VideoEffectShakeDown(bool, int, int, string, TimeSpan, TimeSpan)

Initializes a new instance of the VideoEffectShakeDown class.

Declaration

public VideoEffectShakeDown(bool enabled, int factor = 50, int factorStop = 0, string name = "ShakeDown", TimeSpan startTime = default, TimeSpan stopTime = default)

Parameters

Type	Name	Description
bool	enabled	True to enable effects.
int	factor	Shake down factor value.
int	factorStop	Shake down factor stop value.
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

Factor

Gets or sets shake down factor.

Declaration

public int Factor { get; set; }

Property Value

Type	Description
int

FactorStop

Gets or sets shake down factor stop value (optional).

Declaration

public int FactorStop { get; set; }

Property Value

Type	Description
int

Methods

GetEffectType()

Gets type.

Declaration

public VideoEffectType GetEffectType()

Returns

Type	Description
VideoEffectType	The VideoEffectType.

Implements

IVideoEffectShakeDown

IVideoEffect