Class ScreenSourceBase

A base class for screen-based sources.

Inheritance
System.Object
Serializable
Dynamic
MediaSourceBase
MediaSource<IVideoOutput, IVideoInput, IVideoInputCollection, VideoSource, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>
VideoSource
ScreenSourceBase
MediaProjectionSource
ViewSource
ScreenSource
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public abstract class ScreenSourceBase : VideoSource, IVideoOutput, IMediaOutput<IVideoOutput, IVideoInput, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>, IOutput<IVideoOutput, IVideoInput, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>, IVideoElement, IMediaElement, IElement

Constructors

ScreenSourceBase(VideoFormat, ScreenConfig)

Initializes a new instance of the ScreenSourceBase class.

Declaration
public ScreenSourceBase(VideoFormat outputFormat, ScreenConfig targetConfig)
Parameters
Type Name Description
VideoFormat outputFormat

The output format.
ScreenConfig targetConfig

The target configuration.

Properties

Config

Gets or sets the current config. A value of null indicates unset (pass-through).

Declaration
public ScreenConfig Config { get; protected set; }
Property Value
Type Description
ScreenConfig

FrameRate

Gets or sets the current frame-rate, in fps. A value of -1 indicates unset, and will default to the target frame-rate.

Declaration
public virtual double FrameRate { get; protected set; }
Property Value
Type Description
System.Double

MaxFrameRate

Gets or sets the maximum output frame-rate, in fps. A value of -1 indicates unset (no maximum).

Declaration
public virtual double MaxFrameRate { get; set; }
Property Value
Type Description
System.Double

MaxOutputFrameRate

Gets or sets the maximum allowed output frame-rate, in fps. A value of -1 indicates unset (no maximum).

Declaration
public override double MaxOutputFrameRate { get; protected set; }
Property Value
Type Description
System.Double
Overrides

MaxOutputSize

Gets or sets the maximum allowed output size. A value of null indicates unset (no maximum).

Declaration
public override Size MaxOutputSize { get; protected set; }
Property Value
Type Description
Size
Overrides

MaxSize

Gets or sets the maximum output size. A value of null indicates unset (no maximum).

Declaration
public virtual Size MaxSize { get; set; }
Property Value
Type Description
Size

MaxSupportedFrameRate

Gets the maximum supported frame-rate, in fps. A value of -1 indicates unset (no maximum).

Declaration
public virtual double MaxSupportedFrameRate { get; }
Property Value
Type Description
System.Double

MaxSupportedSize

Gets the maximum supported size. A value of null indicates unset (no maximum).

Declaration
public virtual Size MaxSupportedSize { get; }
Property Value
Type Description
Size

MinFrameRate

Gets or sets the minimum frame-rate, in fps. A value of -1 indicates unset (no minimum).

Declaration
public virtual double MinFrameRate { get; set; }
Property Value
Type Description
System.Double

MinOutputFrameRate

Gets or sets the minimum allowed output frame-rate, in fps. A value of -1 indicates unset (no minimum).

Declaration
public override double MinOutputFrameRate { get; protected set; }
Property Value
Type Description
System.Double
Overrides

MinOutputSize

Gets or sets the minimum allowed output size. A value of null indicates unset (no minimum).

Declaration
public override Size MinOutputSize { get; protected set; }
Property Value
Type Description
Size
Overrides

MinSize

Gets or sets the minimum size. A value of null indicates unset (no minimum).

Declaration
public virtual Size MinSize { get; set; }
Property Value
Type Description
Size

MinSupportedFrameRate

Gets the minimum supported frame-rate, in fps. A value of -1 indicates unset (no minimum).

Declaration
public virtual double MinSupportedFrameRate { get; }
Property Value
Type Description
System.Double

MinSupportedSize

Gets the minimum supported size. A value of null indicates unset (no minimum).

Declaration
public virtual Size MinSupportedSize { get; }
Property Value
Type Description
Size

Origin

Gets or sets the current origin.

Declaration
public virtual Point Origin { get; protected set; }
Property Value
Type Description
Point

Region

Gets or sets the current region.

Declaration
public Rectangle Region { get; protected set; }
Property Value
Type Description
Rectangle

Size

Gets or sets the current size. A value of null indicates unset, and will default to the target size.

Declaration
public virtual Size Size { get; protected set; }
Property Value
Type Description
Size

StaticOutputFrameRate

Gets or sets whether MinOutputFrameRate and MaxOutputFrameRate should return MinSupportedFrameRate and MaxSupportedFrameRate, respectively, or response to changes in MinFrameRate and MaxFrameRate.

Declaration
public bool StaticOutputFrameRate { get; set; }
Property Value
Type Description
System.Boolean

StaticOutputSize

Gets or sets whether MinOutputSize and MaxOutputSize should return MinSupportedSize and MaxSupportedSize, respectively, or response to changes in MinSize and MaxSize.

Declaration
public bool StaticOutputSize { get; set; }
Property Value
Type Description
System.Boolean

TargetConfig

Gets or sets the target config. A value of null indicates unset (no target).

Declaration
public ScreenConfig TargetConfig { get; set; }
Property Value
Type Description
ScreenConfig

TargetFrameRate

Gets or sets the target frame-rate, in fps.

Declaration
public virtual double TargetFrameRate { get; protected set; }
Property Value
Type Description
System.Double

TargetOrigin

Gets or sets the target origin.

Declaration
public virtual Point TargetOrigin { get; set; }
Property Value
Type Description
Point

TargetOutputFrameRate

Gets or sets the target output frame-rate, in fps.

Declaration
public override double TargetOutputFrameRate { get; protected set; }
Property Value
Type Description
System.Double
Overrides

TargetOutputSize

Gets or sets the target output size.

Declaration
public override Size TargetOutputSize { get; protected set; }
Property Value
Type Description
Size
Overrides

TargetRegion

Gets or sets the target region.

Declaration
public Rectangle TargetRegion { get; set; }
Property Value
Type Description
Rectangle

TargetSize

Gets or sets the target size.

Declaration
public virtual Size TargetSize { get; set; }
Property Value
Type Description
Size

Implements