A frame-rate pipe. More...

Public Member Functions
	FrameRatePipe (fm.liveswitch.VideoFormat format)
	Initializes a new instance of the fm.liveswitch.FrameRatePipe class. More...

double	getFrameRate ()
	Gets the current frame-rate, in fps. More...

String	getLabel ()
	Gets a label that identifies this class. More...

double	getMaxFrameRate ()
	Gets the maximum output frame-rate, in fps. More...

double	getMaxOutputFrameRate ()
	Gets the maximum allowed output frame-rate, in fps. More...

double	getMaxSupportedFrameRate ()
	Gets the maximum supported frame-rate, in fps. More...

double	getMinFrameRate ()
	Gets the minimum frame-rate, in fps. More...

double	getMinOutputFrameRate ()
	Gets the minimum allowed output frame-rate, in fps. More...

double	getMinSupportedFrameRate ()
	Gets the minimum supported frame-rate, in fps. More...

boolean	getStaticOutputFrameRate ()
	Gets whether fm.liveswitch.FrameRatePipe#getMinOutputFrameRate and fm.liveswitch.FrameRatePipe#getMaxOutputFrameRate should return fm.liveswitch.FrameRatePipe#getMinSupportedFrameRate and fm.liveswitch.FrameRatePipe#getMaxSupportedFrameRate, respectively, or response to changes in fm.liveswitch.FrameRatePipe#getMinFrameRate and fm.liveswitch.FrameRatePipe#getMaxFrameRate. More...

double	getTargetFrameRate ()
	Gets the target frame-rate, in fps. More...

double	getTargetOutputFrameRate ()
	Gets the target output frame-rate, in fps. More...

void	setMaxFrameRate (double value)
	Sets the maximum output frame-rate, in fps. More...

void	setMinFrameRate (double value)
	Sets the minimum frame-rate, in fps. More...

void	setStaticOutputFrameRate (boolean value)
	Sets whether fm.liveswitch.FrameRatePipe#getMinOutputFrameRate and fm.liveswitch.FrameRatePipe#getMaxOutputFrameRate should return fm.liveswitch.FrameRatePipe#getMinSupportedFrameRate and fm.liveswitch.FrameRatePipe#getMaxSupportedFrameRate, respectively, or response to changes in fm.liveswitch.FrameRatePipe#getMinFrameRate and fm.liveswitch.FrameRatePipe#getMaxFrameRate. More...

void	setTargetFrameRate (double value)
	Sets the target frame-rate, in fps. More...

Public Member Functions inherited from fm.liveswitch.VideoPipe
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...

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...

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...

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 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
void	doDestroy ()
	Destroys this instance. More...

void	doPreProcessFrame (fm.liveswitch.VideoFrame frame, fm.liveswitch.VideoBuffer inputBuffer)
	Pre-processes a frame. More...

void	doProcessFrame (fm.liveswitch.VideoFrame frame, fm.liveswitch.VideoBuffer inputBuffer)
	Processes a frame. More...

void	frameRateChanged (double oldFrameRate, double newFrameRate)
	Indicates that the frame-rate has changed. More...

void	frameRateChanging (double oldFrameRate, double newFrameRate)
	Indicates that the frame-rate is about to change. More...

void	setFrameRate (double value)
	Sets the current frame-rate, in fps. More...

void	setMaxOutputFrameRate (double value)
	Sets the maximum allowed output frame-rate, in fps. More...

void	setMinOutputFrameRate (double value)
	Sets the minimum allowed output frame-rate, in fps. More...

void	setTargetOutputFrameRate (double value)
	Sets the target output frame-rate, in fps. More...

Protected Member Functions inherited from fm.liveswitch.VideoPipe
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...

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	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	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	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 frame-rate pipe.

Constructor & Destructor Documentation

◆ FrameRatePipe()

fm.liveswitch.FrameRatePipe.FrameRatePipe ( fm.liveswitch.VideoFormat format )

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

Parameters

format

Member Function Documentation

◆ doDestroy()

void fm.liveswitch.FrameRatePipe.doDestroy ( )

protected

Destroys this instance.

Reimplemented in fm.liveswitch.FrameRateController.

◆ doPreProcessFrame()

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

protected

Pre-processes a frame.

Parameters

frame	The frame.
inputBuffer	The input buffer.

Reimplemented from fm.liveswitch.VideoPipe.

◆ doProcessFrame()

void fm.liveswitch.FrameRatePipe.doProcessFrame	(	fm.liveswitch.VideoFrame	frame,
		fm.liveswitch.VideoBuffer	inputBuffer
	)

protected

Processes a frame.

Parameters

frame	The frame.
inputBuffer	The input buffer.

Reimplemented in fm.liveswitch.FrameRateController.

◆ frameRateChanged()

void fm.liveswitch.FrameRatePipe.frameRateChanged	(	double	oldFrameRate,
		double	newFrameRate
	)

protected

Indicates that the frame-rate has changed.

Parameters

oldFrameRate	The old frame-rate.
newFrameRate	The new frame-rate.

Reimplemented in fm.liveswitch.FrameRateController.

◆ frameRateChanging()

void fm.liveswitch.FrameRatePipe.frameRateChanging	(	double	oldFrameRate,
		double	newFrameRate
	)

protected

Indicates that the frame-rate is about to change.

Parameters

oldFrameRate	The old frame-rate.
newFrameRate	The new frame-rate.

◆ getFrameRate()

double fm.liveswitch.FrameRatePipe.getFrameRate ( )

Gets the current frame-rate, in fps.

A value of -1 indicates unset (pass-through).

◆ getLabel()

String fm.liveswitch.FrameRatePipe.getLabel ( )

Gets a label that identifies this class.

Implements fm.liveswitch.IMediaElement.

Reimplemented in fm.liveswitch.FrameRateController.

◆ getMaxFrameRate()

double fm.liveswitch.FrameRatePipe.getMaxFrameRate ( )

Gets the maximum output frame-rate, in fps.

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

◆ getMaxOutputFrameRate()

double fm.liveswitch.FrameRatePipe.getMaxOutputFrameRate ( )

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

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

Reimplemented from fm.liveswitch.VideoPipe.

◆ getMaxSupportedFrameRate()

double fm.liveswitch.FrameRatePipe.getMaxSupportedFrameRate ( )

Gets the maximum supported frame-rate, in fps.

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

◆ getMinFrameRate()

double fm.liveswitch.FrameRatePipe.getMinFrameRate ( )

Gets the minimum frame-rate, in fps.

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

◆ getMinOutputFrameRate()

double fm.liveswitch.FrameRatePipe.getMinOutputFrameRate ( )

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

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

Reimplemented from fm.liveswitch.VideoPipe.

◆ getMinSupportedFrameRate()

double fm.liveswitch.FrameRatePipe.getMinSupportedFrameRate ( )

Gets the minimum supported frame-rate, in fps.

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

◆ getStaticOutputFrameRate()

boolean fm.liveswitch.FrameRatePipe.getStaticOutputFrameRate ( )

Gets whether fm.liveswitch.FrameRatePipe#getMinOutputFrameRate and fm.liveswitch.FrameRatePipe#getMaxOutputFrameRate should return fm.liveswitch.FrameRatePipe#getMinSupportedFrameRate and fm.liveswitch.FrameRatePipe#getMaxSupportedFrameRate, respectively, or response to changes in fm.liveswitch.FrameRatePipe#getMinFrameRate and fm.liveswitch.FrameRatePipe#getMaxFrameRate.

◆ getTargetFrameRate()

double fm.liveswitch.FrameRatePipe.getTargetFrameRate ( )

Gets the target frame-rate, in fps.

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

◆ getTargetOutputFrameRate()

double fm.liveswitch.FrameRatePipe.getTargetOutputFrameRate ( )

Gets the target output frame-rate, in fps.

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

Reimplemented from fm.liveswitch.VideoPipe.

◆ setFrameRate()

void fm.liveswitch.FrameRatePipe.setFrameRate ( double value )

protected

Sets the current frame-rate, in fps.

A value of -1 indicates unset (pass-through).

◆ setMaxFrameRate()

void fm.liveswitch.FrameRatePipe.setMaxFrameRate ( double value )

Sets the maximum output frame-rate, in fps.

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

◆ setMaxOutputFrameRate()

void fm.liveswitch.FrameRatePipe.setMaxOutputFrameRate ( double value )

protected

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

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

Reimplemented from fm.liveswitch.VideoPipe.

◆ setMinFrameRate()

void fm.liveswitch.FrameRatePipe.setMinFrameRate ( double value )

Sets the minimum frame-rate, in fps.

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

◆ setMinOutputFrameRate()

void fm.liveswitch.FrameRatePipe.setMinOutputFrameRate ( double value )

protected

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

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

Reimplemented from fm.liveswitch.VideoPipe.

◆ setStaticOutputFrameRate()

void fm.liveswitch.FrameRatePipe.setStaticOutputFrameRate ( boolean value )

Sets whether fm.liveswitch.FrameRatePipe#getMinOutputFrameRate and fm.liveswitch.FrameRatePipe#getMaxOutputFrameRate should return fm.liveswitch.FrameRatePipe#getMinSupportedFrameRate and fm.liveswitch.FrameRatePipe#getMaxSupportedFrameRate, respectively, or response to changes in fm.liveswitch.FrameRatePipe#getMinFrameRate and fm.liveswitch.FrameRatePipe#getMaxFrameRate.

◆ setTargetFrameRate()

void fm.liveswitch.FrameRatePipe.setTargetFrameRate ( double value )

Sets the target frame-rate, in fps.

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

◆ setTargetOutputFrameRate()

void fm.liveswitch.FrameRatePipe.setTargetOutputFrameRate ( double value )

protected

Sets the target output frame-rate, in fps.

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

Reimplemented from fm.liveswitch.VideoPipe.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FrameRatePipe()

Member Function Documentation

◆ doDestroy()

◆ doPreProcessFrame()

◆ doProcessFrame()

◆ frameRateChanged()

◆ frameRateChanging()

◆ getFrameRate()

◆ getLabel()

◆ getMaxFrameRate()

◆ getMaxOutputFrameRate()

◆ getMaxSupportedFrameRate()

◆ getMinFrameRate()

◆ getMinOutputFrameRate()

◆ getMinSupportedFrameRate()

◆ getStaticOutputFrameRate()

◆ getTargetFrameRate()

◆ getTargetOutputFrameRate()

◆ setFrameRate()

◆ setMaxFrameRate()

◆ setMaxOutputFrameRate()

◆ setMinFrameRate()

◆ setMinOutputFrameRate()

◆ setStaticOutputFrameRate()

◆ setTargetFrameRate()

◆ setTargetOutputFrameRate()