fm.liveswitch.IVideoInput Interface Reference

A video input. More...

Public Member Functions
abstract double	getMaxInputFrameRate ()
	Gets the maximum allowed input frame-rate, in fps. More...
abstract int	getMaxInputHeight ()
	Gets the maximum allowed input height. More...
abstract double	getMaxInputScale ()
	Gets the maximum allowed input scale. More...
abstract fm.liveswitch.Size	getMaxInputSize ()
	Gets the maximum allowed input size. More...
abstract int	getMaxInputWidth ()
	Gets the maximum allowed input width. More...
abstract double	getMinInputFrameRate ()
	Gets the minimum allowed input frame-rate, in fps. More...
abstract int	getMinInputHeight ()
	Gets the minimum allowed input height. More...
abstract double	getMinInputScale ()
	Gets the minimum allowed input scale. More...
abstract fm.liveswitch.Size	getMinInputSize ()
	Gets the minimum allowed input size. More...
abstract int	getMinInputWidth ()
	Gets the minimum allowed input width. 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...

Detailed Description

A video input.

Member Function Documentation

getMaxInputFrameRate()

abstract double fm.liveswitch.IVideoInput.getMaxInputFrameRate ( )

abstract

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

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSink, and fm.liveswitch.VideoPipe.

getMaxInputHeight()

abstract int fm.liveswitch.IVideoInput.getMaxInputHeight ( )

abstract

Gets the maximum allowed input height.

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSink, and fm.liveswitch.VideoPipe.

getMaxInputScale()

abstract double fm.liveswitch.IVideoInput.getMaxInputScale ( )

abstract

Gets the maximum allowed input scale.

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSink, and fm.liveswitch.VideoPipe.

getMaxInputSize()

abstract fm.liveswitch.Size fm.liveswitch.IVideoInput.getMaxInputSize ( )

abstract

Gets the maximum allowed input size.

A value of null indicates unset (no maximum).

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSink, and fm.liveswitch.VideoPipe.

getMaxInputWidth()

abstract int fm.liveswitch.IVideoInput.getMaxInputWidth ( )

abstract

Gets the maximum allowed input width.

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSink, and fm.liveswitch.VideoPipe.

getMinInputFrameRate()

abstract double fm.liveswitch.IVideoInput.getMinInputFrameRate ( )

abstract

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

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSink, and fm.liveswitch.VideoPipe.

getMinInputHeight()

abstract int fm.liveswitch.IVideoInput.getMinInputHeight ( )

abstract

Gets the minimum allowed input height.

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSink, and fm.liveswitch.VideoPipe.

getMinInputScale()

abstract double fm.liveswitch.IVideoInput.getMinInputScale ( )

abstract

Gets the minimum allowed input scale.

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSink, and fm.liveswitch.VideoPipe.

getMinInputSize()

abstract fm.liveswitch.Size fm.liveswitch.IVideoInput.getMinInputSize ( )

abstract

Gets the minimum allowed input size.

A value of null indicates unset (no minimum).

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSink, and fm.liveswitch.VideoPipe.

getMinInputWidth()

abstract int fm.liveswitch.IVideoInput.getMinInputWidth ( )

abstract

Gets the minimum allowed input width.

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSink, and fm.liveswitch.VideoPipe.