A base class for camera-based sources. More...

Public Member Functions
	CameraSourceBase (fm.liveswitch.VideoFormat outputFormat, fm.liveswitch.VideoConfig targetConfig)
	Initializes a new instance of the fm.liveswitch.ScreenSourceBase class. More...

fm.liveswitch.VideoConfig	getConfig ()
	Gets the current config. More...

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

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

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

fm.liveswitch.Size	getMaxOutputSize ()
	Gets the maximum allowed output size. More...

fm.liveswitch.Size	getMaxSize ()
	Gets the maximum output size. More...

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

fm.liveswitch.Size	getMaxSupportedSize ()
	Gets the maximum supported size. More...

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

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

fm.liveswitch.Size	getMinOutputSize ()
	Gets the minimum allowed output size. More...

fm.liveswitch.Size	getMinSize ()
	Gets the minimum size. More...

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

fm.liveswitch.Size	getMinSupportedSize ()
	Gets the minimum supported size. More...

fm.liveswitch.Size	getSize ()
	Gets the current size. More...

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

boolean	getStaticOutputSize ()
	Gets whether fm.liveswitch.CameraSourceBase#getMinOutputSize and fm.liveswitch.CameraSourceBase#getMaxOutputSize should return fm.liveswitch.CameraSourceBase#getMinSupportedSize and fm.liveswitch.CameraSourceBase#getMaxSupportedSize, respectively, or response to changes in fm.liveswitch.CameraSourceBase#getMinSize and fm.liveswitch.CameraSourceBase#getMaxSize. More...

fm.liveswitch.VideoConfig	getTargetConfig ()
	Gets the target config. More...

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

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

fm.liveswitch.Size	getTargetOutputSize ()
	Gets the target output size. More...

fm.liveswitch.Size	getTargetSize ()
	Gets the target size. More...

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

void	setMaxSize (fm.liveswitch.Size value)
	Sets the maximum output size. More...

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

void	setMinSize (fm.liveswitch.Size value)
	Sets the minimum size. More...

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

void	setStaticOutputSize (boolean value)
	Sets whether fm.liveswitch.CameraSourceBase#getMinOutputSize and fm.liveswitch.CameraSourceBase#getMaxOutputSize should return fm.liveswitch.CameraSourceBase#getMinSupportedSize and fm.liveswitch.CameraSourceBase#getMaxSupportedSize, respectively, or response to changes in fm.liveswitch.CameraSourceBase#getMinSize and fm.liveswitch.CameraSourceBase#getMaxSize. More...

void	setTargetConfig (fm.liveswitch.VideoConfig value)
	Sets the target config. More...

void	setTargetSize (fm.liveswitch.Size value)
	Sets the target size. More...

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

int	getAverageFrameRate ()
	Gets the average frame rate. More...

String	getContent ()
	Gets the content descriptor. More...

long	getFrameCount ()
	Gets the frame count. More...

double	getFrameRateDistance (double frameRate1, double frameRate2)
	Gets the distance between two frame rates. 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...

int	getMaxOutputWidth ()
	Gets the maximum allowed output 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...

int	getMinOutputWidth ()
	Gets the minimum allowed output width. More...

boolean	getOverConstrainedFrameRate ()
	Gets whether the source frame-rate is over-constrained. More...

boolean	getOverConstrainedHeight ()
	Gets whether the source height is over-constrained. 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 source scale is over-constrained. More...

boolean	getOverConstrainedSize ()
	Gets whether the source size is over-constrained. More...

boolean	getOverConstrainedWidth ()
	Gets whether the source width is over-constrained. More...

int	getSizeDistance (int width1, int height1, int width2, int height2)
	Gets the distance between two sizes. 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...

int	getTargetOutputWidth ()
	Gets the target output width. More...

fm.liveswitch.VideoType	getVideoType ()
	Gets the video type. 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...

	VideoSource (fm.liveswitch.VideoFormat outputFormat)
	Initializes a new instance of the fm.liveswitch.VideoSource class. More...

Public Member Functions inherited from fm.liveswitch.MediaSourceBase
String	getExternalId ()
	Gets the external identifier. More...

String	getId ()
	Gets the identifier. More...

String	getTag ()
	Gets optional data to associate with this instance. More...

void	setExternalId (String value)
	Sets the external identifier. More...

void	setTag (String value)
	Sets optional data to associate with this instance. More...

abstract fm.liveswitch.Future< Object >	start ()
	Starts this instance. More...

abstract fm.liveswitch.Future< Object >	stop ()
	Stops this instance. 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
void	setConfig (fm.liveswitch.VideoConfig value)
	Sets the current config. 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	setMaxOutputSize (fm.liveswitch.Size value)
	Sets the maximum allowed output size. More...

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

void	setMinOutputSize (fm.liveswitch.Size value)
	Sets the minimum allowed output size. More...

void	setSize (fm.liveswitch.Size value)
	Sets the current size. More...

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

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

void	setTargetOutputSize (fm.liveswitch.Size value)
	Sets the target output size. More...

Protected Member Functions inherited from fm.liveswitch.VideoSource
fm.liveswitch.IVideoInputCollection	createInputCollection (fm.liveswitch.IVideoOutput output)
	Creates an input 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	setMaxOutputEncoding (fm.liveswitch.EncodingInfo value)
	Sets the maximum allowed output encoding. More...

void	setMaxOutputScale (double value)
	Sets the maximum allowed output scale. 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	setTargetOutputEncoding (fm.liveswitch.EncodingInfo value)
	Sets the target output encoding. More...

void	setTargetOutputScale (double value)
	Sets the target output scale. More...

void	setVideoType (fm.liveswitch.VideoType value)
	Sets the video type. More...

Protected Member Functions inherited from fm.liveswitch.MediaSourceBase
fm.liveswitch.LogContext	getLogContext ()
	Gets the log context for this connection. More...

	MediaSourceBase ()

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 base class for camera-based sources.

Constructor & Destructor Documentation

◆ CameraSourceBase()

fm.liveswitch.CameraSourceBase.CameraSourceBase	(	fm.liveswitch.VideoFormat	outputFormat,
		fm.liveswitch.VideoConfig	targetConfig
	)

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

Parameters

outputFormat	The output format.
targetConfig	The target configuration.

Member Function Documentation

◆ getConfig()

fm.liveswitch.VideoConfig fm.liveswitch.CameraSourceBase.getConfig ( )

Gets the current config.

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

◆ getFrameRate()

double fm.liveswitch.CameraSourceBase.getFrameRate ( )

Gets the current frame-rate, in fps.

A value of -1 indicates unset, and will default to the target frame-rate.

◆ getMaxFrameRate()

double fm.liveswitch.CameraSourceBase.getMaxFrameRate ( )

Gets the maximum output frame-rate, in fps.

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

◆ getMaxOutputFrameRate()

double fm.liveswitch.CameraSourceBase.getMaxOutputFrameRate ( )

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

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

Reimplemented from fm.liveswitch.VideoSource.

◆ getMaxOutputSize()

fm.liveswitch.Size fm.liveswitch.CameraSourceBase.getMaxOutputSize ( )

Gets the maximum allowed output size.

A value of null indicates unset (no maximum).

Reimplemented from fm.liveswitch.VideoSource.

◆ getMaxSize()

fm.liveswitch.Size fm.liveswitch.CameraSourceBase.getMaxSize ( )

Gets the maximum output size.

A value of null indicates unset (no maximum).

◆ getMaxSupportedFrameRate()

double fm.liveswitch.CameraSourceBase.getMaxSupportedFrameRate ( )

Gets the maximum supported frame-rate, in fps.

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

◆ getMaxSupportedSize()

fm.liveswitch.Size fm.liveswitch.CameraSourceBase.getMaxSupportedSize ( )

Gets the maximum supported size.

A value of null indicates unset (no maximum).

◆ getMinFrameRate()

double fm.liveswitch.CameraSourceBase.getMinFrameRate ( )

Gets the minimum frame-rate, in fps.

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

◆ getMinOutputFrameRate()

double fm.liveswitch.CameraSourceBase.getMinOutputFrameRate ( )

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

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

Reimplemented from fm.liveswitch.VideoSource.

◆ getMinOutputSize()

fm.liveswitch.Size fm.liveswitch.CameraSourceBase.getMinOutputSize ( )

Gets the minimum allowed output size.

A value of null indicates unset (no minimum).

Reimplemented from fm.liveswitch.VideoSource.

◆ getMinSize()

fm.liveswitch.Size fm.liveswitch.CameraSourceBase.getMinSize ( )

Gets the minimum size.

A value of null indicates unset (no minimum).

◆ getMinSupportedFrameRate()

double fm.liveswitch.CameraSourceBase.getMinSupportedFrameRate ( )

Gets the minimum supported frame-rate, in fps.

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

◆ getMinSupportedSize()

fm.liveswitch.Size fm.liveswitch.CameraSourceBase.getMinSupportedSize ( )

Gets the minimum supported size.

A value of null indicates unset (no minimum).

◆ getSize()

fm.liveswitch.Size fm.liveswitch.CameraSourceBase.getSize ( )

Gets the current size.

A value of null indicates unset, and will default to the target size.

◆ getStaticOutputFrameRate()

boolean fm.liveswitch.CameraSourceBase.getStaticOutputFrameRate ( )

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

◆ getStaticOutputSize()

boolean fm.liveswitch.CameraSourceBase.getStaticOutputSize ( )

Gets whether fm.liveswitch.CameraSourceBase#getMinOutputSize and fm.liveswitch.CameraSourceBase#getMaxOutputSize should return fm.liveswitch.CameraSourceBase#getMinSupportedSize and fm.liveswitch.CameraSourceBase#getMaxSupportedSize, respectively, or response to changes in fm.liveswitch.CameraSourceBase#getMinSize and fm.liveswitch.CameraSourceBase#getMaxSize.

◆ getTargetConfig()

fm.liveswitch.VideoConfig fm.liveswitch.CameraSourceBase.getTargetConfig ( )

Gets the target config.

A value of null indicates unset (no target).

◆ getTargetFrameRate()

double fm.liveswitch.CameraSourceBase.getTargetFrameRate ( )

Gets the target frame-rate, in fps.

◆ getTargetOutputFrameRate()

double fm.liveswitch.CameraSourceBase.getTargetOutputFrameRate ( )

Gets the target output frame-rate, in fps.

Reimplemented from fm.liveswitch.VideoSource.

◆ getTargetOutputSize()

fm.liveswitch.Size fm.liveswitch.CameraSourceBase.getTargetOutputSize ( )

Gets the target output size.

Reimplemented from fm.liveswitch.VideoSource.

◆ getTargetSize()

fm.liveswitch.Size fm.liveswitch.CameraSourceBase.getTargetSize ( )

Gets the target size.

◆ setConfig()

void fm.liveswitch.CameraSourceBase.setConfig ( fm.liveswitch.VideoConfig value )

protected

Sets the current config.

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

◆ setFrameRate()

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

protected

Sets the current frame-rate, in fps.

A value of -1 indicates unset, and will default to the target frame-rate.

◆ setMaxFrameRate()

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

Sets the maximum output frame-rate, in fps.

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

◆ setMaxOutputFrameRate()

void fm.liveswitch.CameraSourceBase.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.VideoSource.

◆ setMaxOutputSize()

void fm.liveswitch.CameraSourceBase.setMaxOutputSize ( fm.liveswitch.Size value )

protected

Sets the maximum allowed output size.

A value of null indicates unset (no maximum).

Reimplemented from fm.liveswitch.VideoSource.

◆ setMaxSize()

void fm.liveswitch.CameraSourceBase.setMaxSize ( fm.liveswitch.Size value )

Sets the maximum output size.

A value of null indicates unset (no maximum).

◆ setMinFrameRate()

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

Sets the minimum frame-rate, in fps.

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

◆ setMinOutputFrameRate()

void fm.liveswitch.CameraSourceBase.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.VideoSource.

◆ setMinOutputSize()

void fm.liveswitch.CameraSourceBase.setMinOutputSize ( fm.liveswitch.Size value )

protected

Sets the minimum allowed output size.

A value of null indicates unset (no minimum).

Reimplemented from fm.liveswitch.VideoSource.

◆ setMinSize()

void fm.liveswitch.CameraSourceBase.setMinSize ( fm.liveswitch.Size value )

Sets the minimum size.

A value of null indicates unset (no minimum).

◆ setSize()

void fm.liveswitch.CameraSourceBase.setSize ( fm.liveswitch.Size value )

protected

Sets the current size.

A value of null indicates unset, and will default to the target size.

◆ setStaticOutputFrameRate()

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

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

◆ setStaticOutputSize()

void fm.liveswitch.CameraSourceBase.setStaticOutputSize ( boolean value )

Sets whether fm.liveswitch.CameraSourceBase#getMinOutputSize and fm.liveswitch.CameraSourceBase#getMaxOutputSize should return fm.liveswitch.CameraSourceBase#getMinSupportedSize and fm.liveswitch.CameraSourceBase#getMaxSupportedSize, respectively, or response to changes in fm.liveswitch.CameraSourceBase#getMinSize and fm.liveswitch.CameraSourceBase#getMaxSize.

◆ setTargetConfig()

void fm.liveswitch.CameraSourceBase.setTargetConfig ( fm.liveswitch.VideoConfig value )

Sets the target config.

A value of null indicates unset (no target).

◆ setTargetFrameRate()

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

protected

Sets the target frame-rate, in fps.

◆ setTargetOutputFrameRate()

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

protected

Sets the target output frame-rate, in fps.

Reimplemented from fm.liveswitch.VideoSource.

◆ setTargetOutputSize()

void fm.liveswitch.CameraSourceBase.setTargetOutputSize ( fm.liveswitch.Size value )

protected

Sets the target output size.

Reimplemented from fm.liveswitch.VideoSource.

◆ setTargetSize()

void fm.liveswitch.CameraSourceBase.setTargetSize ( fm.liveswitch.Size value )

Sets the target size.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CameraSourceBase()

Member Function Documentation

◆ getConfig()

◆ getFrameRate()

◆ getMaxFrameRate()

◆ getMaxOutputFrameRate()

◆ getMaxOutputSize()

◆ getMaxSize()

◆ getMaxSupportedFrameRate()

◆ getMaxSupportedSize()

◆ getMinFrameRate()

◆ getMinOutputFrameRate()

◆ getMinOutputSize()

◆ getMinSize()

◆ getMinSupportedFrameRate()

◆ getMinSupportedSize()

◆ getSize()

◆ getStaticOutputFrameRate()

◆ getStaticOutputSize()

◆ getTargetConfig()

◆ getTargetFrameRate()

◆ getTargetOutputFrameRate()

◆ getTargetOutputSize()

◆ getTargetSize()

◆ setConfig()

◆ setFrameRate()

◆ setMaxFrameRate()

◆ setMaxOutputFrameRate()

◆ setMaxOutputSize()

◆ setMaxSize()

◆ setMinFrameRate()

◆ setMinOutputFrameRate()

◆ setMinOutputSize()

◆ setMinSize()

◆ setSize()

◆ setStaticOutputFrameRate()

◆ setStaticOutputSize()

◆ setTargetConfig()

◆ setTargetFrameRate()

◆ setTargetOutputFrameRate()

◆ setTargetOutputSize()

◆ setTargetSize()