fm.liveswitch.VideoSink Class Referenceabstract

A video sink. More...

Public Member Functions

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...
 

Protected Member Functions

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 sink.

Constructor & Destructor Documentation

◆ VideoSink() [1/2]

fm.liveswitch.VideoSink.VideoSink ( )

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

◆ VideoSink() [2/2]

fm.liveswitch.VideoSink.VideoSink ( fm.liveswitch.VideoFormat  inputFormat)

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

Parameters
inputFormatThe input format.

Member Function Documentation

◆ addOnProcessSizeChange()

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

◆ createOutputCollection()

fm.liveswitch.IVideoOutputCollection fm.liveswitch.VideoSink.createOutputCollection ( fm.liveswitch.IVideoInput  input)
protected

Creates an output collection.

Parameters
inputThe input.

◆ doPreProcessFrame()

void fm.liveswitch.VideoSink.doPreProcessFrame ( fm.liveswitch.VideoFrame  frame,
fm.liveswitch.VideoBuffer  inputBuffer 
)
protected

Pre-processes a frame.

Parameters
frameThe frame.
inputBufferThe input buffer.

◆ getContent()

String fm.liveswitch.VideoSink.getContent ( )

Gets the content descriptor.

◆ getMaxInputEncoding()

fm.liveswitch.EncodingInfo fm.liveswitch.VideoSink.getMaxInputEncoding ( )

Gets the maximum allowed input encoding.

◆ getMaxInputFrameRate()

double fm.liveswitch.VideoSink.getMaxInputFrameRate ( )

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

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

Implements fm.liveswitch.IVideoInput.

◆ getMaxInputHeight()

int fm.liveswitch.VideoSink.getMaxInputHeight ( )

Gets the maximum allowed input height.

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

Implements fm.liveswitch.IVideoInput.

◆ getMaxInputScale()

double fm.liveswitch.VideoSink.getMaxInputScale ( )

Gets the maximum allowed input scale.

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

Implements fm.liveswitch.IVideoInput.

◆ getMaxInputSize()

fm.liveswitch.Size fm.liveswitch.VideoSink.getMaxInputSize ( )

Gets the maximum allowed input size.

A value of null indicates unset (no maximum).

Implements fm.liveswitch.IVideoInput.

◆ getMaxInputWidth()

int fm.liveswitch.VideoSink.getMaxInputWidth ( )

Gets the maximum allowed input width.

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

Implements fm.liveswitch.IVideoInput.

◆ getMinInputEncoding()

fm.liveswitch.EncodingInfo fm.liveswitch.VideoSink.getMinInputEncoding ( )

Gets the minimum allowed input encoding.

◆ getMinInputFrameRate()

double fm.liveswitch.VideoSink.getMinInputFrameRate ( )

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

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

Implements fm.liveswitch.IVideoInput.

◆ getMinInputHeight()

int fm.liveswitch.VideoSink.getMinInputHeight ( )

Gets the minimum allowed input height.

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

Implements fm.liveswitch.IVideoInput.

◆ getMinInputScale()

double fm.liveswitch.VideoSink.getMinInputScale ( )

Gets the minimum allowed input scale.

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

Implements fm.liveswitch.IVideoInput.

◆ getMinInputSize()

fm.liveswitch.Size fm.liveswitch.VideoSink.getMinInputSize ( )

Gets the minimum allowed input size.

A value of null indicates unset (no minimum).

Implements fm.liveswitch.IVideoInput.

◆ getMinInputWidth()

int fm.liveswitch.VideoSink.getMinInputWidth ( )

Gets the minimum allowed input width.

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

Implements fm.liveswitch.IVideoInput.

◆ getOverConstrainedFrameRate()

boolean fm.liveswitch.VideoSink.getOverConstrainedFrameRate ( )

Gets whether the sink frame-rate is over-constrained.

A sink frame-rate is over-constrained if the input frame-rate is over-constrained.

◆ getOverConstrainedHeight()

boolean fm.liveswitch.VideoSink.getOverConstrainedHeight ( )

Gets whether the sink height is over-constrained.

A sink height is over-constrained if the input height is over-constrained.

◆ getOverConstrainedInput()

boolean fm.liveswitch.VideoSink.getOverConstrainedInput ( )

Gets whether the input is over-contrained.

An input is over-constrained if it's input bitrate, input scale, input frame-rate, input size is over-contrained.

◆ getOverConstrainedInputFrameRate()

boolean fm.liveswitch.VideoSink.getOverConstrainedInputFrameRate ( )

Gets whether the minimum allowed input frame-rate exceeds the maximum allowed input frame-rate.

◆ getOverConstrainedInputHeight()

boolean fm.liveswitch.VideoSink.getOverConstrainedInputHeight ( )

Gets whether the minimum allowed input height exceeds the maximum allowed input height.

◆ getOverConstrainedInputScale()

boolean fm.liveswitch.VideoSink.getOverConstrainedInputScale ( )

Gets whether the minimum allowed input scale exceeds the maximum allowed input scale.

◆ getOverConstrainedInputSize()

boolean fm.liveswitch.VideoSink.getOverConstrainedInputSize ( )

Gets whether the minimum allowed input size exceeds the maximum allowed input size.

◆ getOverConstrainedInputWidth()

boolean fm.liveswitch.VideoSink.getOverConstrainedInputWidth ( )

Gets whether the minimum allowed input width exceeds the maximum allowed input width.

◆ getOverConstrainedScale()

boolean fm.liveswitch.VideoSink.getOverConstrainedScale ( )

Gets whether the sink scale is over-constrained.

A sink scale is over-constrained if the input scale is over-constrained.

◆ getOverConstrainedSize()

boolean fm.liveswitch.VideoSink.getOverConstrainedSize ( )

Gets whether the sink size is over-constrained.

A sink size is over-constrained if the input size is over-constrained.

◆ getOverConstrainedWidth()

boolean fm.liveswitch.VideoSink.getOverConstrainedWidth ( )

Gets whether the sink width is over-constrained.

A sink width is over-constrained if the input width is over-constrained.

◆ getVideoType()

fm.liveswitch.VideoType fm.liveswitch.VideoSink.getVideoType ( )

Gets the video type.

◆ removeOnProcessSizeChange()

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

◆ setMaxInputEncoding()

void fm.liveswitch.VideoSink.setMaxInputEncoding ( fm.liveswitch.EncodingInfo  value)
protected

Sets the maximum allowed input encoding.

◆ setMaxInputFrameRate()

void fm.liveswitch.VideoSink.setMaxInputFrameRate ( double  value)
protected

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

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

◆ setMaxInputScale()

void fm.liveswitch.VideoSink.setMaxInputScale ( double  value)
protected

Sets the maximum allowed input scale.

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

◆ setMaxInputSize()

void fm.liveswitch.VideoSink.setMaxInputSize ( fm.liveswitch.Size  value)
protected

Sets the maximum allowed input size.

A value of null indicates unset (no maximum).

◆ setMinInputEncoding()

void fm.liveswitch.VideoSink.setMinInputEncoding ( fm.liveswitch.EncodingInfo  value)
protected

Sets the minimum allowed input encoding.

◆ setMinInputFrameRate()

void fm.liveswitch.VideoSink.setMinInputFrameRate ( double  value)
protected

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

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

◆ setMinInputScale()

void fm.liveswitch.VideoSink.setMinInputScale ( double  value)
protected

Sets the minimum allowed input scale.

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

◆ setMinInputSize()

void fm.liveswitch.VideoSink.setMinInputSize ( fm.liveswitch.Size  value)
protected

Sets the minimum allowed input size.

A value of null indicates unset (no minimum).

◆ setVideoType()

void fm.liveswitch.VideoSink.setVideoType ( fm.liveswitch.VideoType  value)
protected

Sets the video type.