fm.liveswitch.ViewSink< T > Class Template Referenceabstract

A video view sink. More...

Public Member Functions

boolean getIsRecording ()
 Gets a value indicating whether a recording icon should be displayed. More...
 
abstract T getView ()
 Gets the view. More...
 
abstract boolean getViewMirror ()
 Gets a value indicating whether the view is mirrored. More...
 
abstract fm.liveswitch.LayoutScale getViewScale ()
 Gets the view scale. More...
 
void setIsRecording (boolean value)
 Sets a value indicating whether a recording icon should be displayed. More...
 
abstract void setViewMirror (boolean value)
 Sets a value indicating whether the view is mirrored. More...
 
abstract void setViewScale (fm.liveswitch.LayoutScale value)
 Sets the view scale. More...
 
 ViewSink ()
 Initializes a new instance of the fm.liveswitch.ViewSink class. More...
 
 ViewSink (fm.liveswitch.IVideoOutput input)
 Initializes a new instance of the fm.liveswitch.ViewSink class. More...
 
 ViewSink (fm.liveswitch.VideoFormat inputFormat)
 Initializes a new instance of the fm.liveswitch.ViewSink class. More...
 
 ViewSink (fm.liveswitch.IVideoOutput[] inputs)
 Initializes a new instance of the fm.liveswitch.ViewSink class. More...
 
- Public Member Functions inherited from fm.liveswitch.VideoSink
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...
 
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 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...
 
boolean getOverConstrainedFrameRate ()
 Gets whether the sink frame-rate is over-constrained. More...
 
boolean getOverConstrainedHeight ()
 Gets whether the sink 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 getOverConstrainedScale ()
 Gets whether the sink scale is over-constrained. More...
 
boolean getOverConstrainedSize ()
 Gets whether the sink size is over-constrained. More...
 
boolean getOverConstrainedWidth ()
 Gets whether the sink width is over-constrained. 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...
 
 VideoSink ()
 Initializes a new instance of the fm.liveswitch.VideoSink class. More...
 
 VideoSink (fm.liveswitch.VideoFormat inputFormat)
 Initializes a new instance of the fm.liveswitch.VideoSink class. More...
 
- Public Member Functions inherited from fm.liveswitch.MediaSinkBase
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...
 
- 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...
 
- Public Member Functions inherited from fm.liveswitch.IViewSink< T >
abstract TView getView ()
 Gets the view. More...
 
abstract boolean getViewMirror ()
 Gets a value indicating whether the view is mirrored. More...
 
abstract fm.liveswitch.LayoutScale getViewScale ()
 Gets the view scale. More...
 
abstract void setViewMirror (boolean value)
 Sets a value indicating whether the view is mirrored. More...
 
abstract void setViewScale (fm.liveswitch.LayoutScale value)
 Sets the view scale. More...
 

Protected Member Functions

void doDestroy ()
 Destroys this instance. More...
 
void doProcessFrame (fm.liveswitch.VideoFrame frame, fm.liveswitch.VideoBuffer inputBuffer)
 Processes a frame. More...
 
abstract void renderBuffer (fm.liveswitch.VideoBuffer inputBuffer)
 Renders the buffer. More...
 
- Protected Member Functions inherited from fm.liveswitch.VideoSink
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...
 
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 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 setVideoType (fm.liveswitch.VideoType value)
 Sets the video type. More...
 
- Protected Member Functions inherited from fm.liveswitch.MediaSinkBase
 MediaSinkBase ()
 
- 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 view sink.

Constructor & Destructor Documentation

◆ ViewSink() [1/4]

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

◆ ViewSink() [2/4]

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

Parameters
inputThe input.

◆ ViewSink() [3/4]

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

Parameters
inputFormatThe input format.

◆ ViewSink() [4/4]

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

Parameters
inputsThe inputs.

Member Function Documentation

◆ doDestroy()

void fm.liveswitch.ViewSink< T >.doDestroy ( )
protected

Destroys this instance.

◆ doProcessFrame()

void fm.liveswitch.ViewSink< T >.doProcessFrame ( fm.liveswitch.VideoFrame  frame,
fm.liveswitch.VideoBuffer  inputBuffer 
)
protected

Processes a frame.

Parameters
frameThe frame.
inputBufferThe input buffer.

◆ getIsRecording()

boolean fm.liveswitch.ViewSink< T >.getIsRecording ( )

Gets a value indicating whether a recording icon should be displayed.

◆ getView()

abstract T fm.liveswitch.ViewSink< T >.getView ( )
abstract

Gets the view.

Reimplemented in fm.liveswitch.NullViewSink< T >.

◆ getViewMirror()

abstract boolean fm.liveswitch.ViewSink< T >.getViewMirror ( )
abstract

Gets a value indicating whether the view is mirrored.

Reimplemented in fm.liveswitch.NullViewSink< T >.

◆ getViewScale()

abstract fm.liveswitch.LayoutScale fm.liveswitch.ViewSink< T >.getViewScale ( )
abstract

Gets the view scale.

Reimplemented in fm.liveswitch.NullViewSink< T >.

◆ renderBuffer()

abstract void fm.liveswitch.ViewSink< T >.renderBuffer ( fm.liveswitch.VideoBuffer  inputBuffer)
abstractprotected

Renders the buffer.

Parameters
inputBufferThe input buffer.

Reimplemented in fm.liveswitch.NullViewSink< T >.

◆ setIsRecording()

void fm.liveswitch.ViewSink< T >.setIsRecording ( boolean  value)

Sets a value indicating whether a recording icon should be displayed.

◆ setViewMirror()

abstract void fm.liveswitch.ViewSink< T >.setViewMirror ( boolean  value)
abstract

Sets a value indicating whether the view is mirrored.

Reimplemented in fm.liveswitch.NullViewSink< T >.

◆ setViewScale()

abstract void fm.liveswitch.ViewSink< T >.setViewScale ( fm.liveswitch.LayoutScale  value)
abstract

Sets the view scale.

Reimplemented in fm.liveswitch.NullViewSink< T >.