Class VideoEffectSaturation

Saturation effect.

Inheritance

object

VideoEffect

VideoEffectSaturation

Implements

IVideoEffectSaturation

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 VideoEffectSaturation : VideoEffect, IVideoEffectSaturation, IVideoEffect

Constructors

VideoEffectSaturation(int, int, string, TimeSpan, TimeSpan, bool)

Initializes a new instance of the VideoEffectSaturation class.

Declaration

public VideoEffectSaturation(int value, int valueStop = 0, string name = "Saturation", TimeSpan startTime = default, TimeSpan stopTime = default, bool enabled = true)

Parameters

Type	Name	Description
int	value	Saturation value. Range is 0-255. Default is 255.
int	valueStop	Saturation stop value. Range is 0-255. Default is 255.
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.
bool	enabled	True to enable effects.

Properties

Value

Gets or sets saturation value. Range is 0-255. Default is 255.

Declaration

public int Value { get; set; }

Property Value

Type	Description
int

ValueStop

Gets or sets saturation stop value (optional). Range is 0-255. Default is 255.

Declaration

public int ValueStop { get; set; }

Property Value

Type	Description
int

Methods

GetEffectType()

Gets type.

Declaration

public VideoEffectType GetEffectType()

Returns

Type	Description
VideoEffectType	The VideoEffectType.

Implements

IVideoEffectSaturation

IVideoEffect