fm.liveswitch.IVideoOutput Interface Reference

A video output. More...

Public Member Functions

abstract double getMaxOutputFrameRate ()
 Gets the maximum allowed output frame-rate, in fps. More...
 
abstract int getMaxOutputHeight ()
 Gets the maximum allowed output height. More...
 
abstract double getMaxOutputScale ()
 Gets the maximum allowed output scale. More...
 
abstract fm.liveswitch.Size getMaxOutputSize ()
 Gets the maximum allowed output size. More...
 
abstract int getMaxOutputWidth ()
 Gets the maximum allowed output width. More...
 
abstract double getMinOutputFrameRate ()
 Gets the minimum allowed output frame-rate, in fps. More...
 
abstract int getMinOutputHeight ()
 Gets the minimum allowed output height. More...
 
abstract double getMinOutputScale ()
 Gets the minimum allowed output scale. More...
 
abstract fm.liveswitch.Size getMinOutputSize ()
 Gets the minimum allowed output size. More...
 
abstract int getMinOutputWidth ()
 Gets the minimum allowed output width. More...
 
abstract double getTargetOutputFrameRate ()
 Gets the target output frame-rate, in fps. More...
 
abstract int getTargetOutputHeight ()
 Gets the target output height. More...
 
abstract double getTargetOutputScale ()
 Gets the target output scale. More...
 
abstract fm.liveswitch.Size getTargetOutputSize ()
 Gets the target output size. More...
 
abstract int getTargetOutputWidth ()
 Gets the target output width. More...
 
abstract fm.liveswitch.VideoType getVideoType ()
 Gets the video type. 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 output.

Member Function Documentation

◆ getMaxOutputFrameRate()

abstract double fm.liveswitch.IVideoOutput.getMaxOutputFrameRate ( )
abstract

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

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSource, fm.liveswitch.VideoPipe, fm.liveswitch.ScreenSourceBase, fm.liveswitch.NullVideoSource, fm.liveswitch.FrameRatePipe, and fm.liveswitch.CameraSourceBase.

◆ getMaxOutputHeight()

abstract int fm.liveswitch.IVideoOutput.getMaxOutputHeight ( )
abstract

Gets the maximum allowed output height.

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

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

◆ getMaxOutputScale()

abstract double fm.liveswitch.IVideoOutput.getMaxOutputScale ( )
abstract

Gets the maximum allowed output scale.

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSource, fm.liveswitch.VideoPipe, and fm.liveswitch.ImageScalePipe.

◆ getMaxOutputSize()

abstract fm.liveswitch.Size fm.liveswitch.IVideoOutput.getMaxOutputSize ( )
abstract

◆ getMaxOutputWidth()

abstract int fm.liveswitch.IVideoOutput.getMaxOutputWidth ( )
abstract

Gets the maximum allowed output width.

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

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

◆ getMinOutputFrameRate()

abstract double fm.liveswitch.IVideoOutput.getMinOutputFrameRate ( )
abstract

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

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSource, fm.liveswitch.VideoPipe, fm.liveswitch.ScreenSourceBase, fm.liveswitch.NullVideoSource, fm.liveswitch.FrameRatePipe, and fm.liveswitch.CameraSourceBase.

◆ getMinOutputHeight()

abstract int fm.liveswitch.IVideoOutput.getMinOutputHeight ( )
abstract

Gets the minimum allowed output height.

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

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

◆ getMinOutputScale()

abstract double fm.liveswitch.IVideoOutput.getMinOutputScale ( )
abstract

Gets the minimum allowed output scale.

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSource, fm.liveswitch.VideoPipe, and fm.liveswitch.ImageScalePipe.

◆ getMinOutputSize()

abstract fm.liveswitch.Size fm.liveswitch.IVideoOutput.getMinOutputSize ( )
abstract

◆ getMinOutputWidth()

abstract int fm.liveswitch.IVideoOutput.getMinOutputWidth ( )
abstract

Gets the minimum allowed output width.

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

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

◆ getTargetOutputFrameRate()

abstract double fm.liveswitch.IVideoOutput.getTargetOutputFrameRate ( )
abstract

◆ getTargetOutputHeight()

abstract int fm.liveswitch.IVideoOutput.getTargetOutputHeight ( )
abstract

Gets the target output height.

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

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

◆ getTargetOutputScale()

abstract double fm.liveswitch.IVideoOutput.getTargetOutputScale ( )
abstract

Gets the target output scale.

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

Implemented in fm.liveswitch.VideoStream, fm.liveswitch.VideoSource, fm.liveswitch.VideoPipe, and fm.liveswitch.ImageScalePipe.

◆ getTargetOutputSize()

abstract fm.liveswitch.Size fm.liveswitch.IVideoOutput.getTargetOutputSize ( )
abstract

◆ getTargetOutputWidth()

abstract int fm.liveswitch.IVideoOutput.getTargetOutputWidth ( )
abstract

Gets the target output width.

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

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

◆ getVideoType()

abstract fm.liveswitch.VideoType fm.liveswitch.IVideoOutput.getVideoType ( )
abstract