Class ScreenConfig

A screen configuration.

Inheritance

System.Object

MediaConfig<ScreenConfig>

ScreenConfig

Inherited Members

MediaConfig<ScreenConfig>.ClockRate

Namespace: FM.LiveSwitch

Assembly: FM.LiveSwitch.dll

Syntax

public class ScreenConfig : MediaConfig<ScreenConfig>

Constructors

ScreenConfig(Point, Size, Double)

Initializes a new instance of the ScreenConfig class.

Declaration

public ScreenConfig(Point origin, Size size, double frameRate)

Parameters

Type	Name	Description
Point	origin	The region origin.
Size	size	The region size.
System.Double	frameRate	The frame rate.

ScreenConfig(Point, Size, Double, Int32)

Initializes a new instance of the ScreenConfig class.

Declaration

public ScreenConfig(Point origin, Size size, double frameRate, int clockRate)

Parameters

Type	Name	Description
Point	origin	The region origin.
Size	size	The region size.
System.Double	frameRate	The frame rate.
System.Int32	clockRate	The clock rate.

ScreenConfig(Rectangle, Double)

Initializes a new instance of the ScreenConfig class.

Declaration

public ScreenConfig(Rectangle region, double frameRate)

Parameters

Type	Name	Description
Rectangle	region	The region.
System.Double	frameRate	The frame rate.

ScreenConfig(Rectangle, Double, Int32)

Initializes a new instance of the ScreenConfig class.

Declaration

public ScreenConfig(Rectangle region, double frameRate, int clockRate)

Parameters

Type	Name	Description
Rectangle	region	The region.
System.Double	frameRate	The frame rate.
System.Int32	clockRate	The clock rate.

ScreenConfig(Int32, Int32, Int32, Int32, Double)

Initializes a new instance of the ScreenConfig class.

Declaration

public ScreenConfig(int x, int y, int width, int height, double frameRate)

Parameters

Type	Name	Description
System.Int32	x	The region origin X coordinate.
System.Int32	y	The region origin Y coordinate.
System.Int32	width	The region size width.
System.Int32	height	The region size height.
System.Double	frameRate	The frame rate.

ScreenConfig(Int32, Int32, Int32, Int32, Double, Int32)

Initializes a new instance of the ScreenConfig class.

Declaration

public ScreenConfig(int x, int y, int width, int height, double frameRate, int clockRate)

Parameters

Type	Name	Description
System.Int32	x	The region origin X coordinate.
System.Int32	y	The region origin Y coordinate.
System.Int32	width	The region size width.
System.Int32	height	The region size height.
System.Double	frameRate	The frame rate.
System.Int32	clockRate	The clock rate.

Properties

FrameRate

Gets or sets the frame-rate.

Declaration

public double FrameRate { get; set; }

Property Value

Type	Description
System.Double

Height

Gets the region size height.

Declaration

public int Height { get; }

Property Value

Type	Description
System.Int32

Origin

Gets or sets the region origin.

Declaration

public Point Origin { get; set; }

Property Value

Type	Description
Point

Region

Gets or sets the region.

Declaration

public Rectangle Region { get; set; }

Property Value

Type	Description
Rectangle

Size

Gets or sets the region size.

Declaration

public Size Size { get; set; }

Property Value

Type	Description
Size

Width

Gets the region size width.

Declaration

public int Width { get; }

Property Value

Type	Description
System.Int32

X

Gets the region origin X coordinate.

Declaration

public int X { get; }

Property Value

Type	Description
System.Int32

Y

Gets the region origin Y coordinate.

Declaration

public int Y { get; }

Property Value

Type	Description
System.Int32

Methods

IsEquivalent(ScreenConfig)

Determines whether the specified configuration is equivalent.

Declaration

public override bool IsEquivalent(ScreenConfig config)

Parameters

Type	Name	Description
ScreenConfig	config	The configuration.

Returns

Type	Description
System.Boolean

Overrides

FM.LiveSwitch.MediaConfig<FM.LiveSwitch.ScreenConfig>.IsEquivalent(FM.LiveSwitch.ScreenConfig)

ToString()

Returns a string that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String