Class IdentityVideoPipe

A video pipe whose output matches its input.

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

IdentityVideoPipe(VideoFormat)

Initializes a new IdentityVideoPipe.

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

The input/output format.

Properties

CanChangeBitrate

Gets whether this pipe can change the output bitrate.

Declaration
protected override bool CanChangeBitrate { get; }
Property Value
Type Description
System.Boolean
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>.CanChangeBitrate

CanPauseBitrate

Gets whether this pipe can pause the output bitrate.

Declaration
protected override bool CanPauseBitrate { get; }
Property Value
Type Description
System.Boolean
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>.CanPauseBitrate

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

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()

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)

UpdateCanChangeBitrate(Boolean)

Sets whether this pipe can change the output bitrate.

Declaration
public void UpdateCanChangeBitrate(bool canChangeBitrate)
Parameters
Type Name Description
System.Boolean canChangeBitrate

Whether this pipe can change the output bitrate.

UpdateCanPauseBitrate(Boolean)

Sets whether this pipe can pause the output bitrate.

Declaration
public void UpdateCanPauseBitrate(bool canPauseBitrate)
Parameters
Type Name Description
System.Boolean canPauseBitrate

Whether this pipe can pause the output bitrate.

UpdateMaxInputBitrate(Int32)

Sets the maximum allowed input bitrate, in kbps. A value of -1 indicates unset, in which case the maximum input bitrate becomes the minimum of all output maximum input bitrates.

Declaration
public virtual void UpdateMaxInputBitrate(int maxInputBitrate)
Parameters
Type Name Description
System.Int32 maxInputBitrate

The maximum allowed input bitrate, in kbps.

UpdateMaxInputEncoding(EncodingInfo)

Sets the maximum allowed input encoding. A value of null indicates unset (no maximum).

Declaration
public virtual void UpdateMaxInputEncoding(EncodingInfo maxInputEncoding)
Parameters
Type Name Description
EncodingInfo maxInputEncoding

The maximum allowed input encoding.

UpdateMaxInputFrameRate(Double)

Sets the maximum allowed input frame-rate. A value of -1 indicates unset (no maximum).

Declaration
public virtual void UpdateMaxInputFrameRate(double maxInputFrameRate)
Parameters
Type Name Description
System.Double maxInputFrameRate

The maximum allowed input frame-rate.

UpdateMaxInputScale(Double)

Sets the maximum allowed input scale. A value of -1 indicates unset (no maximum).

Declaration
public virtual void UpdateMaxInputScale(double maxInputScale)
Parameters
Type Name Description
System.Double maxInputScale

The maximum allowed input scale.

UpdateMaxInputSize(Size)

Sets the maximum allowed input size. A value of -1 indicates unset (no maximum).

Declaration
public virtual void UpdateMaxInputSize(Size maxInputSize)
Parameters
Type Name Description
Size maxInputSize

The maximum allowed input size.

UpdateMaxOutputBitrate(Int32)

Sets the maximum allowed output bitrate, in kbps. A value of -1 indicates unset (no maximum).

Declaration
public virtual void UpdateMaxOutputBitrate(int maxOutputBitrate)
Parameters
Type Name Description
System.Int32 maxOutputBitrate

The maximum allowed output bitrate, in kbps.

UpdateMaxOutputEncoding(EncodingInfo)

Sets the maximum allowed output encoding. A value of null indicates unset (no maximum).

Declaration
public virtual void UpdateMaxOutputEncoding(EncodingInfo maxOutputEncoding)
Parameters
Type Name Description
EncodingInfo maxOutputEncoding

The maximum allowed output encoding.

UpdateMaxOutputFrameRate(Double)

Sets the maximum allowed output frame-rate. A value of -1 indicates unset (no maximum).

Declaration
public virtual void UpdateMaxOutputFrameRate(double maxOutputFrameRate)
Parameters
Type Name Description
System.Double maxOutputFrameRate

The maximum allowed output frame-rate.

UpdateMaxOutputScale(Double)

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

Declaration
public virtual void UpdateMaxOutputScale(double maxOutputScale)
Parameters
Type Name Description
System.Double maxOutputScale

The maximum allowed output scale.

UpdateMaxOutputSize(Size)

Sets the maximum allowed output size. A value of -1 indicates unset (no maximum).

Declaration
public virtual void UpdateMaxOutputSize(Size maxOutputSize)
Parameters
Type Name Description
Size maxOutputSize

The maximum allowed output size.

UpdateMinInputBitrate(Int32)

Sets the minimum allowed input bitrate, in kbps. A value of -1 indicates unset, in which case the minimum input bitrate becomes the maximum of all output minimum input bitrates.

Declaration
public virtual void UpdateMinInputBitrate(int minInputBitrate)
Parameters
Type Name Description
System.Int32 minInputBitrate

The minimum allowed input bitrate, in kbps.

UpdateMinInputEncoding(EncodingInfo)

Sets the minimum allowed input encoding. A value of null indicates unset (no minimum).

Declaration
public virtual void UpdateMinInputEncoding(EncodingInfo minInputEncoding)
Parameters
Type Name Description
EncodingInfo minInputEncoding

The minimum allowed input encoding.

UpdateMinInputFrameRate(Double)

Sets the minimum allowed input frame-rate. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateMinInputFrameRate(double minInputFrameRate)
Parameters
Type Name Description
System.Double minInputFrameRate

The minimum allowed input frame-rate.

UpdateMinInputScale(Double)

Sets the minimum allowed input scale. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateMinInputScale(double minInputScale)
Parameters
Type Name Description
System.Double minInputScale

The minimum allowed input scale.

UpdateMinInputSize(Size)

Sets the minimum allowed input size. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateMinInputSize(Size minInputSize)
Parameters
Type Name Description
Size minInputSize

The minimum allowed input size.

UpdateMinOutputBitrate(Int32)

Sets the minimum allowed output bitrate, in kbps. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateMinOutputBitrate(int minOutputBitrate)
Parameters
Type Name Description
System.Int32 minOutputBitrate

The minimum allowed output bitrate, in kbps.

UpdateMinOutputEncoding(EncodingInfo)

Sets the minimum allowed output encoding. A value of null indicates unset (no minimum).

Declaration
public virtual void UpdateMinOutputEncoding(EncodingInfo minOutputEncoding)
Parameters
Type Name Description
EncodingInfo minOutputEncoding

The minimum allowed output encoding.

UpdateMinOutputFrameRate(Double)

Sets the minimum allowed output frame-rate. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateMinOutputFrameRate(double minOutputFrameRate)
Parameters
Type Name Description
System.Double minOutputFrameRate

The minimum allowed output frame-rate.

UpdateMinOutputScale(Double)

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

Declaration
public virtual void UpdateMinOutputScale(double minOutputScale)
Parameters
Type Name Description
System.Double minOutputScale

The minimum allowed output scale.

UpdateMinOutputSize(Size)

Sets the minimum allowed output size. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateMinOutputSize(Size minOutputSize)
Parameters
Type Name Description
Size minOutputSize

The minimum allowed output size.

UpdateTargetOutputBitrate(Int32)

Sets the target output bitrate, in kbps. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateTargetOutputBitrate(int targetOutputBitrate)
Parameters
Type Name Description
System.Int32 targetOutputBitrate

The target output bitrate, in kbps.

UpdateTargetOutputEncoding(EncodingInfo)

Sets the target output encoding. A value of null indicates unset (no target).

Declaration
public virtual void UpdateTargetOutputEncoding(EncodingInfo targetOutputEncoding)
Parameters
Type Name Description
EncodingInfo targetOutputEncoding

The target output encoding.

UpdateTargetOutputFrameRate(Double)

Sets the target output frame-rate. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateTargetOutputFrameRate(double targetOutputFrameRate)
Parameters
Type Name Description
System.Double targetOutputFrameRate

The target output frame-rate.

UpdateTargetOutputScale(Double)

Sets the target output scale. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateTargetOutputScale(double targetOutputScale)
Parameters
Type Name Description
System.Double targetOutputScale

The target output scale.

UpdateTargetOutputSize(Size)

Sets the target output size. A value of -1 indicates unset (no minimum).

Declaration
public virtual void UpdateTargetOutputSize(Size targetOutputSize)
Parameters
Type Name Description
Size targetOutputSize

The target output size.

UpdateVideoType(VideoType)

Sets the video type.

Declaration
public void UpdateVideoType(VideoType videoType)
Parameters
Type Name Description
VideoType videoType

The video type.

Implements