fm.liveswitch.VideoPipe Class Referenceabstract

A video pipe. More...

Public Member Functions

void addOnProcessSizeChange (fm.liveswitch.IAction1< fm.liveswitch.Size > value)
 Adds a handler that is raised when a frame is about to be processed with a size that does not match the prior frame. More...
 
void addOnRaiseSizeChange (fm.liveswitch.IAction1< fm.liveswitch.Size > value)
 Adds a handler that is raised when a frame is about to be raised with a size that does not match the prior frame. More...
 
String getContent ()
 Gets the content descriptor. More...
 
fm.liveswitch.EncodingInfo getMaxInputEncoding ()
 Gets the maximum allowed input encoding. More...
 
double getMaxInputFrameRate ()
 Gets the maximum allowed input frame-rate, in fps. More...
 
int getMaxInputHeight ()
 Gets the maximum allowed input height. More...
 
double getMaxInputScale ()
 Gets the maximum allowed input scale. More...
 
fm.liveswitch.Size getMaxInputSize ()
 Gets the maximum allowed input size. More...
 
int getMaxInputWidth ()
 Gets the maximum allowed input width. More...
 
fm.liveswitch.EncodingInfo getMaxOutputEncoding ()
 Gets the maximum allowed output encoding. More...
 
double getMaxOutputFrameRate ()
 Gets the maximum allowed output frame-rate, in fps. More...
 
int getMaxOutputHeight ()
 Gets the maximum allowed output height. More...
 
double getMaxOutputScale ()
 Gets the maximum allowed output scale. More...
 
fm.liveswitch.Size getMaxOutputSize ()
 Gets the maximum allowed output size. More...
 
int getMaxOutputWidth ()
 Gets the maximum allowed output width. More...
 
fm.liveswitch.EncodingInfo getMinInputEncoding ()
 Gets the minimum allowed input encoding. More...
 
double getMinInputFrameRate ()
 Gets the minimum allowed input frame-rate, in fps. More...
 
int getMinInputHeight ()
 Gets the minimum allowed input height. More...
 
double getMinInputScale ()
 Gets the minimum allowed input scale. More...
 
fm.liveswitch.Size getMinInputSize ()
 Gets the minimum allowed input size. More...
 
int getMinInputWidth ()
 Gets the minimum allowed input width. More...
 
fm.liveswitch.EncodingInfo getMinOutputEncoding ()
 Gets the minimum allowed output encoding. More...
 
double getMinOutputFrameRate ()
 Gets the minimum allowed output frame-rate, in fps. More...
 
int getMinOutputHeight ()
 Gets the minimum allowed output height. More...
 
double getMinOutputScale ()
 Gets the minimum allowed output scale. More...
 
fm.liveswitch.Size getMinOutputSize ()
 Gets the minimum allowed output size. More...
 
int getMinOutputWidth ()
 Gets the minimum allowed output width. More...
 
boolean getOverConstrainedFrameRate ()
 Gets whether the pipe frame-rate is over-constrained. More...
 
boolean getOverConstrainedHeight ()
 Gets whether the pipe height is over-constrained. More...
 
boolean getOverConstrainedInput ()
 Gets whether the input is over-contrained. More...
 
boolean getOverConstrainedInputFrameRate ()
 Gets whether the minimum allowed input frame-rate exceeds the maximum allowed input frame-rate. More...
 
boolean getOverConstrainedInputHeight ()
 Gets whether the minimum allowed input height exceeds the maximum allowed input height. More...
 
boolean getOverConstrainedInputScale ()
 Gets whether the minimum allowed input scale exceeds the maximum allowed input scale. More...
 
boolean getOverConstrainedInputSize ()
 Gets whether the minimum allowed input size exceeds the maximum allowed input size. More...
 
boolean getOverConstrainedInputWidth ()
 Gets whether the minimum allowed input width exceeds the maximum allowed input width. More...
 
boolean getOverConstrainedOutput ()
 Gets whether the output is over-contrained. More...
 
boolean getOverConstrainedOutputFrameRate ()
 Gets whether the minimum allowed output frame-rate exceeds the maximum allowed output frame-rate. More...
 
boolean getOverConstrainedOutputHeight ()
 Gets whether the minimum allowed output height exceeds the maximum allowed output height. More...
 
boolean getOverConstrainedOutputScale ()
 Gets whether the minimum allowed output scale exceeds the maximum allowed output scale. More...
 
boolean getOverConstrainedOutputSize ()
 Gets whether the minimum allowed output size exceeds the maximum allowed output size. More...
 
boolean getOverConstrainedOutputWidth ()
 Gets whether the minimum allowed output width exceeds the maximum allowed output width. More...
 
boolean getOverConstrainedScale ()
 Gets whether the pipe scale is over-constrained. More...
 
boolean getOverConstrainedSize ()
 Gets whether the pipe size is over-constrained. More...
 
boolean getOverConstrainedWidth ()
 Gets whether the pipe width is over-constrained. More...
 
fm.liveswitch.EncodingInfo getTargetOutputEncoding ()
 Gets the target output encoding. More...
 
double getTargetOutputFrameRate ()
 Gets the target output frame-rate, in fps. More...
 
int getTargetOutputHeight ()
 Gets the target output height. More...
 
double getTargetOutputScale ()
 Gets the target output scale. More...
 
fm.liveswitch.Size getTargetOutputSize ()
 Gets the target output size. More...
 
int getTargetOutputWidth ()
 Gets the target output width. More...
 
fm.liveswitch.VideoType getVideoType ()
 Gets the video type. More...
 
void removeOnProcessSizeChange (fm.liveswitch.IAction1< fm.liveswitch.Size > value)
 Removes a handler that is raised when a frame is about to be processed with a size that does not match the prior frame. More...
 
void removeOnRaiseSizeChange (fm.liveswitch.IAction1< fm.liveswitch.Size > value)
 Removes a handler that is raised when a frame is about to be raised with a size that does not match the prior frame. More...
 
 VideoPipe (fm.liveswitch.VideoFormat inputFormat, fm.liveswitch.VideoFormat outputFormat)
 Initializes a new instance of the fm.liveswitch.VideoPipe class. More...
 
 VideoPipe (fm.liveswitch.VideoFormat outputFormat)
 Initializes a new instance of the fm.liveswitch.VideoPipe class. More...
 
- Public Member Functions inherited from fm.liveswitch.Dynamic
java.util.HashMap< String, Object > getDynamicProperties ()
 Gets all dynamic properties on this instance. More...
 
Object getDynamicValue (String key)
 Gets a property value from the local cache. More...
 
void setDynamicValue (String key, Object value)
 Sets a property value in the local cache. More...
 
boolean unsetDynamicValue (String key)
 Removes a property value from the local cache. More...
 
- Public Member Functions inherited from fm.liveswitch.IElement
abstract String getExternalId ()
 Gets the external identifier. More...
 
abstract String getId ()
 Gets the identifier. More...
 
abstract String getPipelineJson ()
 Gets the pipeline JSON with this as the central point. More...
 
abstract void setExternalId (String value)
 Sets the external identifier. More...
 
- Public Member Functions inherited from fm.liveswitch.IMediaElement
abstract boolean destroy ()
 Destroys this instance. More...
 
abstract boolean getDeactivated ()
 Gets a value indicating whether this instance is deactivated. More...
 
abstract boolean getDisabled ()
 Gets a value indicating whether this instance is disabled. More...
 
abstract String getLabel ()
 Gets a label that identifies this instance. More...
 
abstract boolean getMuted ()
 Gets a value indicating whether this instance is muted. More...
 
abstract boolean getPaused ()
 Gets a value indicating whether this instance is paused. More...
 
abstract boolean getPersistent ()
 Gets a value indicating whether this instance is persistent. More...
 
abstract void setDeactivated (boolean value)
 Sets a value indicating whether this instance is deactivated. More...
 
abstract void setMuted (boolean value)
 Sets a value indicating whether this instance is muted. More...
 

Protected Member Functions

fm.liveswitch.VideoFrame createFrame (fm.liveswitch.VideoBuffer buffer)
 Creates a frame. More...
 
fm.liveswitch.IVideoInputCollection createInputCollection (fm.liveswitch.IVideoOutput output)
 Creates an input collection. More...
 
fm.liveswitch.IVideoOutputCollection createOutputCollection (fm.liveswitch.IVideoInput input)
 Creates an output collection. More...
 
void doPreProcessFrame (fm.liveswitch.VideoFrame frame, fm.liveswitch.VideoBuffer inputBuffer)
 Pre-processes a frame. More...
 
boolean outputCanProcessFrame (fm.liveswitch.IVideoInput output)
 Determines whether an output can process a frame from this pipe. More...
 
void raiseFrame (fm.liveswitch.VideoFrame frame)
 Raises a frame. More...
 
void setMaxInputEncoding (fm.liveswitch.EncodingInfo value)
 Sets the maximum allowed input encoding. More...
 
void setMaxInputFrameRate (double value)
 Sets the maximum allowed input frame-rate, in fps. More...
 
void setMaxInputScale (double value)
 Sets the maximum allowed input scale. More...
 
void setMaxInputSize (fm.liveswitch.Size value)
 Sets the maximum allowed input size. More...
 
void setMaxOutputEncoding (fm.liveswitch.EncodingInfo value)
 Sets the maximum allowed output encoding. More...
 
void setMaxOutputFrameRate (double value)
 Sets the maximum allowed output frame-rate, in fps. More...
 
void setMaxOutputScale (double value)
 Sets the maximum allowed output scale. More...
 
void setMaxOutputSize (fm.liveswitch.Size value)
 Sets the maximum allowed output size. More...
 
void setMinInputEncoding (fm.liveswitch.EncodingInfo value)
 Sets the minimum allowed input encoding. More...
 
void setMinInputFrameRate (double value)
 Sets the minimum allowed input frame-rate, in fps. More...
 
void setMinInputScale (double value)
 Sets the minimum allowed input scale. More...
 
void setMinInputSize (fm.liveswitch.Size value)
 Sets the minimum allowed input size. More...
 
void setMinOutputEncoding (fm.liveswitch.EncodingInfo value)
 Sets the minimum allowed output encoding. More...
 
void setMinOutputFrameRate (double value)
 Sets the minimum allowed output frame-rate, in fps. More...
 
void setMinOutputScale (double value)
 Sets the minimum allowed output scale. More...
 
void setMinOutputSize (fm.liveswitch.Size value)
 Sets the minimum allowed output size. More...
 
void setTargetOutputEncoding (fm.liveswitch.EncodingInfo value)
 Sets the target output encoding. More...
 
void setTargetOutputFrameRate (double value)
 Sets the target output frame-rate, in fps. More...
 
void setTargetOutputScale (double value)
 Sets the target output scale. More...
 
void setTargetOutputSize (fm.liveswitch.Size value)
 Sets the target output size. More...
 
void setVideoType (fm.liveswitch.VideoType value)
 Sets the video type. More...
 
- Protected Member Functions inherited from fm.liveswitch.Dynamic
 Dynamic ()
 
- Protected Member Functions inherited from fm.liveswitch.Serializable
boolean getIsDirty ()
 Gets a value indicating whether this instance is dirty. More...
 
 Serializable ()
 Initializes a new instance of the fm.liveswitch.Serializable class. More...
 
void setIsDirty (boolean value)
 Sets a value indicating whether this instance is dirty. More...
 

Detailed Description

A video pipe.

Constructor & Destructor Documentation

◆ VideoPipe() [1/2]

fm.liveswitch.VideoPipe.VideoPipe ( fm.liveswitch.VideoFormat  inputFormat,
fm.liveswitch.VideoFormat  outputFormat 
)

Initializes a new instance of the fm.liveswitch.VideoPipe class.

Parameters
inputFormatThe input format.
outputFormatThe output format.

◆ VideoPipe() [2/2]

fm.liveswitch.VideoPipe.VideoPipe ( fm.liveswitch.VideoFormat  outputFormat)

Initializes a new instance of the fm.liveswitch.VideoPipe class.

Parameters
outputFormatThe output format.

Member Function Documentation

◆ addOnProcessSizeChange()

void fm.liveswitch.VideoPipe.addOnProcessSizeChange ( fm.liveswitch.IAction1< fm.liveswitch.Size value)

Adds a handler that is raised when a frame is about to be processed with a size that does not match the prior frame.

◆ addOnRaiseSizeChange()

void fm.liveswitch.VideoPipe.addOnRaiseSizeChange ( fm.liveswitch.IAction1< fm.liveswitch.Size value)

Adds a handler that is raised when a frame is about to be raised with a size that does not match the prior frame.

◆ createFrame()

fm.liveswitch.VideoFrame fm.liveswitch.VideoPipe.createFrame ( fm.liveswitch.VideoBuffer  buffer)
protected

Creates a frame.

Parameters
bufferThe buffer.

◆ createInputCollection()

fm.liveswitch.IVideoInputCollection fm.liveswitch.VideoPipe.createInputCollection ( fm.liveswitch.IVideoOutput  output)
protected

Creates an input collection.

Parameters
outputThe output.

◆ createOutputCollection()

fm.liveswitch.IVideoOutputCollection fm.liveswitch.VideoPipe.createOutputCollection ( fm.liveswitch.IVideoInput  input)
protected

Creates an output collection.

Parameters
inputThe input.

◆ doPreProcessFrame()

void fm.liveswitch.VideoPipe.doPreProcessFrame ( fm.liveswitch.VideoFrame  frame,
fm.liveswitch.VideoBuffer  inputBuffer 
)
protected

Pre-processes a frame.

Parameters
frameThe frame.
inputBufferThe input buffer.

Reimplemented in fm.liveswitch.ImageSizePipe, fm.liveswitch.ImageScalePipe, and fm.liveswitch.FrameRatePipe.

◆ getContent()

String fm.liveswitch.VideoPipe.getContent ( )

Gets the content descriptor.

◆ getMaxInputEncoding()

fm.liveswitch.EncodingInfo fm.liveswitch.VideoPipe.getMaxInputEncoding ( )

Gets the maximum allowed input encoding.

◆ getMaxInputFrameRate()

double fm.liveswitch.VideoPipe.getMaxInputFrameRate ( )

Gets the maximum allowed input frame-rate, in fps.

A value of -1 indicates unset (no maximum).

Implements fm.liveswitch.IVideoInput.

◆ getMaxInputHeight()

int fm.liveswitch.VideoPipe.getMaxInputHeight ( )

Gets the maximum allowed input height.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoInput.

◆ getMaxInputScale()

double fm.liveswitch.VideoPipe.getMaxInputScale ( )

Gets the maximum allowed input scale.

A value of -1 indicates unset (no maximum).

Implements fm.liveswitch.IVideoInput.

◆ getMaxInputSize()

fm.liveswitch.Size fm.liveswitch.VideoPipe.getMaxInputSize ( )

Gets the maximum allowed input size.

A value of null indicates unset (no maximum).

Implements fm.liveswitch.IVideoInput.

◆ getMaxInputWidth()

int fm.liveswitch.VideoPipe.getMaxInputWidth ( )

Gets the maximum allowed input width.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoInput.

◆ getMaxOutputEncoding()

fm.liveswitch.EncodingInfo fm.liveswitch.VideoPipe.getMaxOutputEncoding ( )

Gets the maximum allowed output encoding.

◆ getMaxOutputFrameRate()

double fm.liveswitch.VideoPipe.getMaxOutputFrameRate ( )

Gets the maximum allowed output frame-rate, in fps.

A value of -1 indicates unset (no maximum).

Implements fm.liveswitch.IVideoOutput.

Reimplemented in fm.liveswitch.FrameRatePipe.

◆ getMaxOutputHeight()

int fm.liveswitch.VideoPipe.getMaxOutputHeight ( )

Gets the maximum allowed output height.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoOutput.

◆ getMaxOutputScale()

double fm.liveswitch.VideoPipe.getMaxOutputScale ( )

Gets the maximum allowed output scale.

A value of -1 indicates unset (no maximum).

Implements fm.liveswitch.IVideoOutput.

Reimplemented in fm.liveswitch.ImageScalePipe.

◆ getMaxOutputSize()

fm.liveswitch.Size fm.liveswitch.VideoPipe.getMaxOutputSize ( )

Gets the maximum allowed output size.

A value of null indicates unset (no maximum).

Implements fm.liveswitch.IVideoOutput.

Reimplemented in fm.liveswitch.ImageSizePipe.

◆ getMaxOutputWidth()

int fm.liveswitch.VideoPipe.getMaxOutputWidth ( )

Gets the maximum allowed output width.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoOutput.

◆ getMinInputEncoding()

fm.liveswitch.EncodingInfo fm.liveswitch.VideoPipe.getMinInputEncoding ( )

Gets the minimum allowed input encoding.

◆ getMinInputFrameRate()

double fm.liveswitch.VideoPipe.getMinInputFrameRate ( )

Gets the minimum allowed input frame-rate, in fps.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoInput.

◆ getMinInputHeight()

int fm.liveswitch.VideoPipe.getMinInputHeight ( )

Gets the minimum allowed input height.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoInput.

◆ getMinInputScale()

double fm.liveswitch.VideoPipe.getMinInputScale ( )

Gets the minimum allowed input scale.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoInput.

◆ getMinInputSize()

fm.liveswitch.Size fm.liveswitch.VideoPipe.getMinInputSize ( )

Gets the minimum allowed input size.

A value of null indicates unset (no minimum).

Implements fm.liveswitch.IVideoInput.

◆ getMinInputWidth()

int fm.liveswitch.VideoPipe.getMinInputWidth ( )

Gets the minimum allowed input width.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoInput.

◆ getMinOutputEncoding()

fm.liveswitch.EncodingInfo fm.liveswitch.VideoPipe.getMinOutputEncoding ( )

Gets the minimum allowed output encoding.

◆ getMinOutputFrameRate()

double fm.liveswitch.VideoPipe.getMinOutputFrameRate ( )

Gets the minimum allowed output frame-rate, in fps.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoOutput.

Reimplemented in fm.liveswitch.FrameRatePipe.

◆ getMinOutputHeight()

int fm.liveswitch.VideoPipe.getMinOutputHeight ( )

Gets the minimum allowed output height.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoOutput.

◆ getMinOutputScale()

double fm.liveswitch.VideoPipe.getMinOutputScale ( )

Gets the minimum allowed output scale.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoOutput.

Reimplemented in fm.liveswitch.ImageScalePipe.

◆ getMinOutputSize()

fm.liveswitch.Size fm.liveswitch.VideoPipe.getMinOutputSize ( )

Gets the minimum allowed output size.

A value of null indicates unset (no minimum).

Implements fm.liveswitch.IVideoOutput.

Reimplemented in fm.liveswitch.ImageSizePipe.

◆ getMinOutputWidth()

int fm.liveswitch.VideoPipe.getMinOutputWidth ( )

Gets the minimum allowed output width.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoOutput.

◆ getOverConstrainedFrameRate()

boolean fm.liveswitch.VideoPipe.getOverConstrainedFrameRate ( )

Gets whether the pipe frame-rate is over-constrained.

A pipe frame-rate is over-constrained if the input frame-rate or output frame-rate is over-constrained.

◆ getOverConstrainedHeight()

boolean fm.liveswitch.VideoPipe.getOverConstrainedHeight ( )

Gets whether the pipe height is over-constrained.

A pipe height is over-constrained if the input height or output height is over-constrained.

◆ getOverConstrainedInput()

boolean fm.liveswitch.VideoPipe.getOverConstrainedInput ( )

Gets whether the input is over-contrained.

An input is over-constrained if it's input bitrate, input scale, input frame-rate, input size is over-contrained.

◆ getOverConstrainedInputFrameRate()

boolean fm.liveswitch.VideoPipe.getOverConstrainedInputFrameRate ( )

Gets whether the minimum allowed input frame-rate exceeds the maximum allowed input frame-rate.

◆ getOverConstrainedInputHeight()

boolean fm.liveswitch.VideoPipe.getOverConstrainedInputHeight ( )

Gets whether the minimum allowed input height exceeds the maximum allowed input height.

◆ getOverConstrainedInputScale()

boolean fm.liveswitch.VideoPipe.getOverConstrainedInputScale ( )

Gets whether the minimum allowed input scale exceeds the maximum allowed input scale.

◆ getOverConstrainedInputSize()

boolean fm.liveswitch.VideoPipe.getOverConstrainedInputSize ( )

Gets whether the minimum allowed input size exceeds the maximum allowed input size.

◆ getOverConstrainedInputWidth()

boolean fm.liveswitch.VideoPipe.getOverConstrainedInputWidth ( )

Gets whether the minimum allowed input width exceeds the maximum allowed input width.

◆ getOverConstrainedOutput()

boolean fm.liveswitch.VideoPipe.getOverConstrainedOutput ( )

Gets whether the output is over-contrained.

An output is over-constrained if it's output bitrate, output scale, output frame-rate, output size is over-contrained.

◆ getOverConstrainedOutputFrameRate()

boolean fm.liveswitch.VideoPipe.getOverConstrainedOutputFrameRate ( )

Gets whether the minimum allowed output frame-rate exceeds the maximum allowed output frame-rate.

◆ getOverConstrainedOutputHeight()

boolean fm.liveswitch.VideoPipe.getOverConstrainedOutputHeight ( )

Gets whether the minimum allowed output height exceeds the maximum allowed output height.

◆ getOverConstrainedOutputScale()

boolean fm.liveswitch.VideoPipe.getOverConstrainedOutputScale ( )

Gets whether the minimum allowed output scale exceeds the maximum allowed output scale.

◆ getOverConstrainedOutputSize()

boolean fm.liveswitch.VideoPipe.getOverConstrainedOutputSize ( )

Gets whether the minimum allowed output size exceeds the maximum allowed output size.

◆ getOverConstrainedOutputWidth()

boolean fm.liveswitch.VideoPipe.getOverConstrainedOutputWidth ( )

Gets whether the minimum allowed output width exceeds the maximum allowed output width.

◆ getOverConstrainedScale()

boolean fm.liveswitch.VideoPipe.getOverConstrainedScale ( )

Gets whether the pipe scale is over-constrained.

A pipe scale is over-constrained if the input scale or output scale is over-constrained.

◆ getOverConstrainedSize()

boolean fm.liveswitch.VideoPipe.getOverConstrainedSize ( )

Gets whether the pipe size is over-constrained.

A pipe size is over-constrained if the input size or output size is over-constrained.

◆ getOverConstrainedWidth()

boolean fm.liveswitch.VideoPipe.getOverConstrainedWidth ( )

Gets whether the pipe width is over-constrained.

A pipe width is over-constrained if the input width or output width is over-constrained.

◆ getTargetOutputEncoding()

fm.liveswitch.EncodingInfo fm.liveswitch.VideoPipe.getTargetOutputEncoding ( )

Gets the target output encoding.

◆ getTargetOutputFrameRate()

double fm.liveswitch.VideoPipe.getTargetOutputFrameRate ( )

Gets the target output frame-rate, in fps.

A value of -1 indicates unset (no target).

Implements fm.liveswitch.IVideoOutput.

Reimplemented in fm.liveswitch.FrameRatePipe.

◆ getTargetOutputHeight()

int fm.liveswitch.VideoPipe.getTargetOutputHeight ( )

Gets the target output height.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoOutput.

◆ getTargetOutputScale()

double fm.liveswitch.VideoPipe.getTargetOutputScale ( )

Gets the target output scale.

A value of -1 indicates unset (no target).

Implements fm.liveswitch.IVideoOutput.

Reimplemented in fm.liveswitch.ImageScalePipe.

◆ getTargetOutputSize()

fm.liveswitch.Size fm.liveswitch.VideoPipe.getTargetOutputSize ( )

Gets the target output size.

A value of null indicates unset (no target).

Implements fm.liveswitch.IVideoOutput.

Reimplemented in fm.liveswitch.ImageSizePipe.

◆ getTargetOutputWidth()

int fm.liveswitch.VideoPipe.getTargetOutputWidth ( )

Gets the target output width.

A value of -1 indicates unset (no minimum).

Implements fm.liveswitch.IVideoOutput.

◆ getVideoType()

fm.liveswitch.VideoType fm.liveswitch.VideoPipe.getVideoType ( )

Gets the video type.

Implements fm.liveswitch.IVideoOutput.

◆ outputCanProcessFrame()

boolean fm.liveswitch.VideoPipe.outputCanProcessFrame ( fm.liveswitch.IVideoInput  output)
protected

Determines whether an output can process a frame from this pipe.

Parameters
outputThe output.

◆ raiseFrame()

void fm.liveswitch.VideoPipe.raiseFrame ( fm.liveswitch.VideoFrame  frame)
protected

Raises a frame.

Parameters
frameThe frame.

Reimplemented in fm.liveswitch.VideoEncoder, and fm.liveswitch.VideoDecoder.

◆ removeOnProcessSizeChange()

void fm.liveswitch.VideoPipe.removeOnProcessSizeChange ( fm.liveswitch.IAction1< fm.liveswitch.Size value)

Removes a handler that is raised when a frame is about to be processed with a size that does not match the prior frame.

◆ removeOnRaiseSizeChange()

void fm.liveswitch.VideoPipe.removeOnRaiseSizeChange ( fm.liveswitch.IAction1< fm.liveswitch.Size value)

Removes a handler that is raised when a frame is about to be raised with a size that does not match the prior frame.

◆ setMaxInputEncoding()

void fm.liveswitch.VideoPipe.setMaxInputEncoding ( fm.liveswitch.EncodingInfo  value)
protected

Sets the maximum allowed input encoding.

◆ setMaxInputFrameRate()

void fm.liveswitch.VideoPipe.setMaxInputFrameRate ( double  value)
protected

Sets the maximum allowed input frame-rate, in fps.

A value of -1 indicates unset (no maximum).

◆ setMaxInputScale()

void fm.liveswitch.VideoPipe.setMaxInputScale ( double  value)
protected

Sets the maximum allowed input scale.

A value of -1 indicates unset (no maximum).

◆ setMaxInputSize()

void fm.liveswitch.VideoPipe.setMaxInputSize ( fm.liveswitch.Size  value)
protected

Sets the maximum allowed input size.

A value of null indicates unset (no maximum).

◆ setMaxOutputEncoding()

void fm.liveswitch.VideoPipe.setMaxOutputEncoding ( fm.liveswitch.EncodingInfo  value)
protected

Sets the maximum allowed output encoding.

◆ setMaxOutputFrameRate()

void fm.liveswitch.VideoPipe.setMaxOutputFrameRate ( double  value)
protected

Sets the maximum allowed output frame-rate, in fps.

A value of -1 indicates unset (no maximum).

Reimplemented in fm.liveswitch.FrameRatePipe.

◆ setMaxOutputScale()

void fm.liveswitch.VideoPipe.setMaxOutputScale ( double  value)
protected

Sets the maximum allowed output scale.

A value of -1 indicates unset (no maximum).

Reimplemented in fm.liveswitch.ImageScalePipe.

◆ setMaxOutputSize()

void fm.liveswitch.VideoPipe.setMaxOutputSize ( fm.liveswitch.Size  value)
protected

Sets the maximum allowed output size.

A value of null indicates unset (no maximum).

Reimplemented in fm.liveswitch.ImageSizePipe.

◆ setMinInputEncoding()

void fm.liveswitch.VideoPipe.setMinInputEncoding ( fm.liveswitch.EncodingInfo  value)
protected

Sets the minimum allowed input encoding.

◆ setMinInputFrameRate()

void fm.liveswitch.VideoPipe.setMinInputFrameRate ( double  value)
protected

Sets the minimum allowed input frame-rate, in fps.

A value of -1 indicates unset (no minimum).

◆ setMinInputScale()

void fm.liveswitch.VideoPipe.setMinInputScale ( double  value)
protected

Sets the minimum allowed input scale.

A value of -1 indicates unset (no minimum).

◆ setMinInputSize()

void fm.liveswitch.VideoPipe.setMinInputSize ( fm.liveswitch.Size  value)
protected

Sets the minimum allowed input size.

A value of null indicates unset (no minimum).

◆ setMinOutputEncoding()

void fm.liveswitch.VideoPipe.setMinOutputEncoding ( fm.liveswitch.EncodingInfo  value)
protected

Sets the minimum allowed output encoding.

◆ setMinOutputFrameRate()

void fm.liveswitch.VideoPipe.setMinOutputFrameRate ( double  value)
protected

Sets the minimum allowed output frame-rate, in fps.

A value of -1 indicates unset (no minimum).

Reimplemented in fm.liveswitch.FrameRatePipe.

◆ setMinOutputScale()

void fm.liveswitch.VideoPipe.setMinOutputScale ( double  value)
protected

Sets the minimum allowed output scale.

A value of -1 indicates unset (no minimum).

Reimplemented in fm.liveswitch.ImageScalePipe.

◆ setMinOutputSize()

void fm.liveswitch.VideoPipe.setMinOutputSize ( fm.liveswitch.Size  value)
protected

Sets the minimum allowed output size.

A value of null indicates unset (no minimum).

Reimplemented in fm.liveswitch.ImageSizePipe.

◆ setTargetOutputEncoding()

void fm.liveswitch.VideoPipe.setTargetOutputEncoding ( fm.liveswitch.EncodingInfo  value)
protected

Sets the target output encoding.

◆ setTargetOutputFrameRate()

void fm.liveswitch.VideoPipe.setTargetOutputFrameRate ( double  value)
protected

Sets the target output frame-rate, in fps.

A value of -1 indicates unset (no target).

Reimplemented in fm.liveswitch.FrameRatePipe.

◆ setTargetOutputScale()

void fm.liveswitch.VideoPipe.setTargetOutputScale ( double  value)
protected

Sets the target output scale.

A value of -1 indicates unset (no target).

Reimplemented in fm.liveswitch.ImageScalePipe.

◆ setTargetOutputSize()

void fm.liveswitch.VideoPipe.setTargetOutputSize ( fm.liveswitch.Size  value)
protected

Sets the target output size.

A value of null indicates unset (no target).

Reimplemented in fm.liveswitch.ImageSizePipe.

◆ setVideoType()

void fm.liveswitch.VideoPipe.setVideoType ( fm.liveswitch.VideoType  value)
protected

Sets the video type.