Class ImageSizePipe

An image size pipe.

Inheritance
System.Object
Serializable
Dynamic
MediaPipe<IVideoOutput, IVideoOutputCollection, IVideoInput, IVideoInputCollection, VideoPipe, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>
VideoPipe
ImageSizePipe
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public class ImageSizePipe : 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

ImageSizePipe(VideoFormat)

Initializes a new instance of the ImageSizePipe class.

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

The output format.

ImageSizePipe(VideoFormat, VideoFormat)

Initializes a new instance of the ImageSizePipe class.

Declaration
public ImageSizePipe(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

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

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

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

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

Size

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

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

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

TargetOutputSize

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

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

TargetSize

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

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

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)

SizeChanged(Size, Size)

Indicates that the size has changed.

Declaration
protected virtual void SizeChanged(Size oldSize, Size newSize)
Parameters
Type Name Description
Size oldSize

The old size.
Size newSize

The new size.

SizeChanging(Size, Size)

Indicates that the size is about to change.

Declaration
protected virtual void SizeChanging(Size oldSize, Size newSize)
Parameters
Type Name Description
Size oldSize

The old size.
Size newSize

The new size.

Implements