Class FrameRatePipe

A frame-rate pipe.

Inheritance
System.Object
Serializable
Dynamic
MediaPipe<IVideoOutput, IVideoOutputCollection, IVideoInput, IVideoInputCollection, VideoPipe, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>
VideoPipe
FrameRatePipe
FrameRateController
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 FrameRatePipe : 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

FrameRatePipe(VideoFormat)

Initializes a new instance of the FrameRatePipe class.

Declaration
public FrameRatePipe(VideoFormat format)
Parameters
Type Name Description
VideoFormat format

Properties

FrameRate

Gets or sets the current frame-rate, in fps. A value of -1 indicates unset (pass-through).

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

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

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

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

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

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

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

TargetFrameRate

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

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

TargetOutputFrameRate

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

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

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)

FrameRateChanged(Double, Double)

Indicates that the frame-rate has changed.

Declaration
protected virtual void FrameRateChanged(double oldFrameRate, double newFrameRate)
Parameters
Type Name Description
System.Double oldFrameRate

The old frame-rate.
System.Double newFrameRate

The new frame-rate.

FrameRateChanging(Double, Double)

Indicates that the frame-rate is about to change.

Declaration
protected virtual void FrameRateChanging(double oldFrameRate, double newFrameRate)
Parameters
Type Name Description
System.Double oldFrameRate

The old frame-rate.
System.Double newFrameRate

The new frame-rate.

Implements