fm.liveswitch.IdentityVideoPipe Class Reference

A video pipe whose output matches its input. More...

Public Member Functions
String	getLabel ()
	Gets a label that identifies this class. More...
	IdentityVideoPipe (fm.liveswitch.VideoFormat format)
	Initializes a new fm.liveswitch.IdentityVideoPipe. More...
void	updateCanChangeBitrate (boolean canChangeBitrate)
	Sets whether this pipe can change the output bitrate. More...
void	updateCanPauseBitrate (boolean canPauseBitrate)
	Sets whether this pipe can pause the output bitrate. More...
void	updateMaxInputBitrate (int maxInputBitrate)
	Sets the maximum allowed input bitrate, in kbps. More...
void	updateMaxInputEncoding (fm.liveswitch.EncodingInfo maxInputEncoding)
	Sets the maximum allowed input encoding. More...
void	updateMaxInputFrameRate (double maxInputFrameRate)
	Sets the maximum allowed input frame-rate. More...
void	updateMaxInputScale (double maxInputScale)
	Sets the maximum allowed input scale. More...
void	updateMaxInputSize (fm.liveswitch.Size maxInputSize)
	Sets the maximum allowed input size. More...
void	updateMaxOutputBitrate (int maxOutputBitrate)
	Sets the maximum allowed output bitrate, in kbps. More...
void	updateMaxOutputEncoding (fm.liveswitch.EncodingInfo maxOutputEncoding)
	Sets the maximum allowed output encoding. More...
void	updateMaxOutputFrameRate (double maxOutputFrameRate)
	Sets the maximum allowed output frame-rate. More...
void	updateMaxOutputScale (double maxOutputScale)
	Sets the maximum allowed output scale. More...
void	updateMaxOutputSize (fm.liveswitch.Size maxOutputSize)
	Sets the maximum allowed output size. More...
void	updateMinInputBitrate (int minInputBitrate)
	Sets the minimum allowed input bitrate, in kbps. More...
void	updateMinInputEncoding (fm.liveswitch.EncodingInfo minInputEncoding)
	Sets the minimum allowed input encoding. More...
void	updateMinInputFrameRate (double minInputFrameRate)
	Sets the minimum allowed input frame-rate. More...
void	updateMinInputScale (double minInputScale)
	Sets the minimum allowed input scale. More...
void	updateMinInputSize (fm.liveswitch.Size minInputSize)
	Sets the minimum allowed input size. More...
void	updateMinOutputBitrate (int minOutputBitrate)
	Sets the minimum allowed output bitrate, in kbps. More...
void	updateMinOutputEncoding (fm.liveswitch.EncodingInfo minOutputEncoding)
	Sets the minimum allowed output encoding. More...
void	updateMinOutputFrameRate (double minOutputFrameRate)
	Sets the minimum allowed output frame-rate. More...
void	updateMinOutputScale (double minOutputScale)
	Sets the minimum allowed output scale. More...
void	updateMinOutputSize (fm.liveswitch.Size minOutputSize)
	Sets the minimum allowed output size. More...
void	updateTargetOutputBitrate (int targetOutputBitrate)
	Sets the target output bitrate, in kbps. More...
void	updateTargetOutputEncoding (fm.liveswitch.EncodingInfo targetOutputEncoding)
	Sets the target output encoding. More...
void	updateTargetOutputFrameRate (double targetOutputFrameRate)
	Sets the target output frame-rate. More...
void	updateTargetOutputScale (double targetOutputScale)
	Sets the target output scale. More...
void	updateTargetOutputSize (fm.liveswitch.Size targetOutputSize)
	Sets the target output size. More...
void	updateVideoType (fm.liveswitch.VideoType videoType)
	Sets the video type. 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...
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 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	doProcessFrame (fm.liveswitch.VideoFrame frame, fm.liveswitch.VideoBuffer inputBuffer)
	Processes a frame. More...
boolean	getCanChangeBitrate ()
	Gets whether this pipe can change the output bitrate. More...
boolean	getCanPauseBitrate ()
	Gets whether this pipe can pause the output bitrate. 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...
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 whose output matches its input.

Constructor & Destructor Documentation

IdentityVideoPipe()

fm.liveswitch.IdentityVideoPipe.IdentityVideoPipe

(

fm.liveswitch.VideoFormat

format

)

Initializes a new fm.liveswitch.IdentityVideoPipe.

Parameters

format

The input/output format.

Member Function Documentation

doDestroy()

void fm.liveswitch.IdentityVideoPipe.doDestroy ( )

protected

Destroys this instance.

doProcessFrame()

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

protected

Processes a frame.

Parameters

frame	The frame.
inputBuffer	The input buffer.

getCanChangeBitrate()

boolean fm.liveswitch.IdentityVideoPipe.getCanChangeBitrate ( )

protected

Gets whether this pipe can change the output bitrate.

getCanPauseBitrate()

boolean fm.liveswitch.IdentityVideoPipe.getCanPauseBitrate ( )

protected

Gets whether this pipe can pause the output bitrate.

getLabel()

String fm.liveswitch.IdentityVideoPipe.getLabel

(

)

Gets a label that identifies this class.

Implements fm.liveswitch.IMediaElement.

updateCanChangeBitrate()

void fm.liveswitch.IdentityVideoPipe.updateCanChangeBitrate

(

boolean

canChangeBitrate

)

Sets whether this pipe can change the output bitrate.

Parameters

canChangeBitrate

Whether this pipe can change the output bitrate.

updateCanPauseBitrate()

void fm.liveswitch.IdentityVideoPipe.updateCanPauseBitrate

(

boolean

canPauseBitrate

)

Sets whether this pipe can pause the output bitrate.

Parameters

canPauseBitrate

Whether this pipe can pause the output bitrate.

updateMaxInputBitrate()

void fm.liveswitch.IdentityVideoPipe.updateMaxInputBitrate

(

int

maxInputBitrate

)

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.

Parameters

maxInputBitrate

The maximum allowed input bitrate, in kbps.

updateMaxInputEncoding()

void fm.liveswitch.IdentityVideoPipe.updateMaxInputEncoding

(

fm.liveswitch.EncodingInfo

maxInputEncoding

)

Sets the maximum allowed input encoding.

A value of null indicates unset (no maximum).

Parameters

maxInputEncoding

The maximum allowed input encoding.

updateMaxInputFrameRate()

void fm.liveswitch.IdentityVideoPipe.updateMaxInputFrameRate

(

double

maxInputFrameRate

)

Sets the maximum allowed input frame-rate.

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

Parameters

maxInputFrameRate

The maximum allowed input frame-rate.

updateMaxInputScale()

void fm.liveswitch.IdentityVideoPipe.updateMaxInputScale

(

double

maxInputScale

)

Sets the maximum allowed input scale.

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

Parameters

maxInputScale

The maximum allowed input scale.

updateMaxInputSize()

void fm.liveswitch.IdentityVideoPipe.updateMaxInputSize

(

fm.liveswitch.Size

maxInputSize

)

Sets the maximum allowed input size.

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

Parameters

maxInputSize

The maximum allowed input size.

updateMaxOutputBitrate()

void fm.liveswitch.IdentityVideoPipe.updateMaxOutputBitrate

(

int

maxOutputBitrate

)

Sets the maximum allowed output bitrate, in kbps.

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

Parameters

maxOutputBitrate

The maximum allowed output bitrate, in kbps.

updateMaxOutputEncoding()

void fm.liveswitch.IdentityVideoPipe.updateMaxOutputEncoding

(

fm.liveswitch.EncodingInfo

maxOutputEncoding

)

Sets the maximum allowed output encoding.

A value of null indicates unset (no maximum).

Parameters

maxOutputEncoding

The maximum allowed output encoding.

updateMaxOutputFrameRate()

void fm.liveswitch.IdentityVideoPipe.updateMaxOutputFrameRate

(

double

maxOutputFrameRate

)

Sets the maximum allowed output frame-rate.

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

Parameters

maxOutputFrameRate

The maximum allowed output frame-rate.

updateMaxOutputScale()

void fm.liveswitch.IdentityVideoPipe.updateMaxOutputScale

(

double

maxOutputScale

)

Sets the maximum allowed output scale.

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

Parameters

maxOutputScale

The maximum allowed output scale.

updateMaxOutputSize()

void fm.liveswitch.IdentityVideoPipe.updateMaxOutputSize

(

fm.liveswitch.Size

maxOutputSize

)

Sets the maximum allowed output size.

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

Parameters

maxOutputSize

The maximum allowed output size.

updateMinInputBitrate()

void fm.liveswitch.IdentityVideoPipe.updateMinInputBitrate

(

int

minInputBitrate

)

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.

Parameters

minInputBitrate

The minimum allowed input bitrate, in kbps.

updateMinInputEncoding()

void fm.liveswitch.IdentityVideoPipe.updateMinInputEncoding

(

fm.liveswitch.EncodingInfo

minInputEncoding

)

Sets the minimum allowed input encoding.

A value of null indicates unset (no minimum).

Parameters

minInputEncoding

The minimum allowed input encoding.

updateMinInputFrameRate()

void fm.liveswitch.IdentityVideoPipe.updateMinInputFrameRate

(

double

minInputFrameRate

)

Sets the minimum allowed input frame-rate.

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

Parameters

minInputFrameRate

The minimum allowed input frame-rate.

updateMinInputScale()

void fm.liveswitch.IdentityVideoPipe.updateMinInputScale

(

double

minInputScale

)

Sets the minimum allowed input scale.

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

Parameters

minInputScale

The minimum allowed input scale.

updateMinInputSize()

void fm.liveswitch.IdentityVideoPipe.updateMinInputSize

(

fm.liveswitch.Size

minInputSize

)

Sets the minimum allowed input size.

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

Parameters

minInputSize

The minimum allowed input size.

updateMinOutputBitrate()

void fm.liveswitch.IdentityVideoPipe.updateMinOutputBitrate

(

int

minOutputBitrate

)

Sets the minimum allowed output bitrate, in kbps.

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

Parameters

minOutputBitrate

The minimum allowed output bitrate, in kbps.

updateMinOutputEncoding()

void fm.liveswitch.IdentityVideoPipe.updateMinOutputEncoding

(

fm.liveswitch.EncodingInfo

minOutputEncoding

)

Sets the minimum allowed output encoding.

A value of null indicates unset (no minimum).

Parameters

minOutputEncoding

The minimum allowed output encoding.

updateMinOutputFrameRate()

void fm.liveswitch.IdentityVideoPipe.updateMinOutputFrameRate

(

double

minOutputFrameRate

)

Sets the minimum allowed output frame-rate.

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

Parameters

minOutputFrameRate

The minimum allowed output frame-rate.

updateMinOutputScale()

void fm.liveswitch.IdentityVideoPipe.updateMinOutputScale

(

double

minOutputScale

)

Sets the minimum allowed output scale.

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

Parameters

minOutputScale

The minimum allowed output scale.

updateMinOutputSize()

void fm.liveswitch.IdentityVideoPipe.updateMinOutputSize

(

fm.liveswitch.Size

minOutputSize

)

Sets the minimum allowed output size.

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

Parameters

minOutputSize

The minimum allowed output size.

updateTargetOutputBitrate()

void fm.liveswitch.IdentityVideoPipe.updateTargetOutputBitrate

(

int

targetOutputBitrate

)

Sets the target output bitrate, in kbps.

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

Parameters

targetOutputBitrate

The target output bitrate, in kbps.

updateTargetOutputEncoding()

void fm.liveswitch.IdentityVideoPipe.updateTargetOutputEncoding

(

fm.liveswitch.EncodingInfo

targetOutputEncoding

)

Sets the target output encoding.

A value of null indicates unset (no target).

Parameters

targetOutputEncoding

The target output encoding.

updateTargetOutputFrameRate()

void fm.liveswitch.IdentityVideoPipe.updateTargetOutputFrameRate

(

double

targetOutputFrameRate

)

Sets the target output frame-rate.

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

Parameters

targetOutputFrameRate

The target output frame-rate.

updateTargetOutputScale()

void fm.liveswitch.IdentityVideoPipe.updateTargetOutputScale

(

double

targetOutputScale

)

Sets the target output scale.

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

Parameters

targetOutputScale

The target output scale.

updateTargetOutputSize()

void fm.liveswitch.IdentityVideoPipe.updateTargetOutputSize

(

fm.liveswitch.Size

targetOutputSize

)

Sets the target output size.

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

Parameters

targetOutputSize

The target output size.

updateVideoType()

void fm.liveswitch.IdentityVideoPipe.updateVideoType

(

fm.liveswitch.VideoType

videoType

)

Sets the video type.

Parameters

videoType

The video type.