Class ImageScalePipe

An image scale pipe.

Inheritance
System.Object
Serializable
Dynamic
MediaPipe<IVideoOutput, IVideoOutputCollection, IVideoInput, IVideoInputCollection, VideoPipe, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>
VideoPipe
ImageScalePipe
ImageConverter
ImageScaler
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 class ImageScalePipe : VideoPipe, IVideoInput, IMediaInput<IVideoOutput, IVideoInput, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>, IInput<IVideoOutput, IVideoInput, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>, IVideoOutput, IMediaOutput<IVideoOutput, IVideoInput, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>, IOutput<IVideoOutput, IVideoInput, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>, IVideoElement, IMediaElement, IElement

Constructors

ImageScalePipe(VideoFormat)

Initializes a new instance of the ImageScalePipe class.

Declaration
public ImageScalePipe(VideoFormat outputFormat)
Parameters
Type Name Description
VideoFormat outputFormat

The output format.

ImageScalePipe(VideoFormat, VideoFormat)

Initializes a new instance of the ImageScalePipe class.

Declaration
public ImageScalePipe(VideoFormat inputFormat, VideoFormat outputFormat)
Parameters
Type Name Description
VideoFormat inputFormat

The input format.
VideoFormat outputFormat

The output format.

Properties

Label

Gets a label that identifies this class.

Declaration
public override string Label { get; }
Property Value
Type Description
System.String
Overrides
FM.LiveSwitch.MediaPipe<FM.LiveSwitch.IVideoOutput, FM.LiveSwitch.IVideoOutputCollection, FM.LiveSwitch.IVideoInput, FM.LiveSwitch.IVideoInputCollection, FM.LiveSwitch.VideoPipe, FM.LiveSwitch.VideoFrame, FM.LiveSwitch.VideoBuffer, FM.LiveSwitch.VideoBufferCollection, FM.LiveSwitch.VideoFormat>.Label

MaxOutputScale

Gets or sets the maximum allowed output scale. A value of -1 indicates unset (no maximum).

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

MaxScale

Gets or sets the maximum output scale. A value of -1 indicates unset (no maximum).

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

MaxSupportedScale

Gets the maximum supported scale. A value of -1 indicates unset (no maximum).

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

MinOutputScale

Gets or sets the minimum allowed output scale. A value of -1 indicates unset (no minimum).

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

MinScale

Gets or sets the minimum output scale. A value of -1 indicates unset (no minimum).

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

MinSupportedScale

Gets the minimum supported scale. A value of -1 indicates unset (no minimum).

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

Scale

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

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

StaticOutputScale

Gets or sets whether MinOutputScale and MaxOutputScale should return MinSupportedScale and MaxSupportedScale, respectively, or response to changes in MinScale and MaxScale.

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

TargetOutputScale

Gets or sets the target output scale. A value of -1 indicates unset (no target).

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

TargetScale

Gets or sets the target scale. A value of -1 indicates unset (no target).

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

Methods

DoDestroy()

Destroys this instance.

Declaration
protected override void DoDestroy()
Overrides
FM.LiveSwitch.MediaPipe<FM.LiveSwitch.IVideoOutput, FM.LiveSwitch.IVideoOutputCollection, FM.LiveSwitch.IVideoInput, FM.LiveSwitch.IVideoInputCollection, FM.LiveSwitch.VideoPipe, FM.LiveSwitch.VideoFrame, FM.LiveSwitch.VideoBuffer, FM.LiveSwitch.VideoBufferCollection, FM.LiveSwitch.VideoFormat>.DoDestroy()

DoPreProcessFrame(VideoFrame, VideoBuffer)

Pre-processes a frame.

Declaration
protected override void DoPreProcessFrame(VideoFrame frame, VideoBuffer inputBuffer)
Parameters
Type Name Description
VideoFrame frame

The frame.
VideoBuffer inputBuffer

The input buffer.
Overrides

DoProcessFrame(VideoFrame, VideoBuffer)

Processes a frame.

Declaration
protected override void DoProcessFrame(VideoFrame frame, VideoBuffer inputBuffer)
Parameters
Type Name Description
VideoFrame frame

The frame.
VideoBuffer inputBuffer

The input buffer.
Overrides
FM.LiveSwitch.MediaPipe<FM.LiveSwitch.IVideoOutput, FM.LiveSwitch.IVideoOutputCollection, FM.LiveSwitch.IVideoInput, FM.LiveSwitch.IVideoInputCollection, FM.LiveSwitch.VideoPipe, FM.LiveSwitch.VideoFrame, FM.LiveSwitch.VideoBuffer, FM.LiveSwitch.VideoBufferCollection, FM.LiveSwitch.VideoFormat>.DoProcessFrame(FM.LiveSwitch.VideoFrame, FM.LiveSwitch.VideoBuffer)

ScaleChanged(Double, Double)

Indicates that the scale has changed.

Declaration
protected virtual void ScaleChanged(double oldScale, double newScale)
Parameters
Type Name Description
System.Double oldScale

The old scale.
System.Double newScale

The new scale.

ScaleChanging(Double, Double)

Indicates that the scale is about to change.

Declaration
protected virtual void ScaleChanging(double oldScale, double newScale)
Parameters
Type Name Description
System.Double oldScale

The old scale.
System.Double newScale

The new scale.

Implements