fm.liveswitch.NullVideoSink Class Reference

A video sink that discards frames. More...

Public Member Functions

long getFrameCount ()
 Gets the current frame count. More...
 
String getLabel ()
 Gets a label that identifies this class. More...
 
String getOutputRtpStreamId ()
 Gets the output RTP stream identifier. More...
 
long getOutputSynchronizationSource ()
 Gets the output synchronization source. More...
 
 NullVideoSink ()
 Initializes a new fm.liveswitch.NullVideoSink. More...
 
 NullVideoSink (fm.liveswitch.VideoFormat inputFormat)
 Initializes a new fm.liveswitch.NullVideoSink. More...
 
void processControlFrame (fm.liveswitch.MediaControlFrame controlFrame)
 Processes a control frame by raising it. More...
 
void processControlFrames (fm.liveswitch.MediaControlFrame[] controlFrames)
 Processes control frames by raising them. More...
 
fm.liveswitch.Future< Object > processedFrames (long count)
 Creates a future that resolves when the specified number of frames have been processed. More...
 
void setOutputRtpStreamId (String value)
 Sets the output RTP stream identifier. More...
 
void setOutputSynchronizationSource (long value)
 Sets the output synchronization source. More...
 
void updateMaxInputBitrate (int maxInputBitrate)
 Sets the maximum allowed input bitrate, in kbps. More...
 
void updateMaxInputEncoding (fm.liveswitch.EncodingInfo maxInputEncoding)
 Sets the maximum allowed input encoding. More...
 
void updateMaxInputFrameRate (double maxInputFrameRate)
 Sets the maximum allowed input frame-rate. More...
 
void updateMaxInputScale (double maxInputScale)
 Sets the maximum allowed input scale. More...
 
void updateMaxInputSize (fm.liveswitch.Size maxInputSize)
 Sets the maximum allowed input size. More...
 
void updateMinInputBitrate (int minInputBitrate)
 Sets the minimum allowed input bitrate, in kbps. More...
 
void updateMinInputEncoding (fm.liveswitch.EncodingInfo minInputEncoding)
 Sets the minimum allowed input encoding. More...
 
void updateMinInputFrameRate (double minInputFrameRate)
 Sets the minimum allowed input frame-rate. More...
 
void updateMinInputScale (double minInputScale)
 Sets the minimum allowed input scale. More...
 
void updateMinInputSize (fm.liveswitch.Size minInputSize)
 Sets the minimum allowed input size. More...
 
void updateSystemDelay (long systemDelay)
 Sets the system delay in ticks. More...
 
void updateVideoType (fm.liveswitch.VideoType videoType)
 Sets the video type. 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 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 doDestroy ()
 Destroys this instance. More...
 
void doProcessFrame (fm.liveswitch.VideoFrame frame, fm.liveswitch.VideoBuffer inputBuffer)
 Processes a frame. 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 sink that discards frames.

Constructor & Destructor Documentation

◆ NullVideoSink() [1/2]

fm.liveswitch.NullVideoSink.NullVideoSink ( )

Initializes a new fm.liveswitch.NullVideoSink.

◆ NullVideoSink() [2/2]

fm.liveswitch.NullVideoSink.NullVideoSink ( fm.liveswitch.VideoFormat  inputFormat)

Initializes a new fm.liveswitch.NullVideoSink.

Parameters
inputFormatThe input format.

Member Function Documentation

◆ doDestroy()

void fm.liveswitch.NullVideoSink.doDestroy ( )
protected

Destroys this instance.

◆ doProcessFrame()

void fm.liveswitch.NullVideoSink.doProcessFrame ( fm.liveswitch.VideoFrame  frame,
fm.liveswitch.VideoBuffer  inputBuffer 
)
protected

Processes a frame.

Parameters
frameThe frame.
inputBufferThe input buffer.

◆ getFrameCount()

long fm.liveswitch.NullVideoSink.getFrameCount ( )

Gets the current frame count.

◆ getLabel()

String fm.liveswitch.NullVideoSink.getLabel ( )

Gets a label that identifies this class.

Implements fm.liveswitch.IMediaElement.

◆ getOutputRtpStreamId()

String fm.liveswitch.NullVideoSink.getOutputRtpStreamId ( )

Gets the output RTP stream identifier.

If the output RTP stream identifier is null (unset), then getting this property returns the InputRtpStreamId.

◆ getOutputSynchronizationSource()

long fm.liveswitch.NullVideoSink.getOutputSynchronizationSource ( )

Gets the output synchronization source.

If the output synchronization source is -1 (unset), then getting this property returns the InputSynchronizationSource.

◆ processControlFrame()

void fm.liveswitch.NullVideoSink.processControlFrame ( fm.liveswitch.MediaControlFrame  controlFrame)

Processes a control frame by raising it.

Parameters
controlFrameThe control frame.

◆ processControlFrames()

void fm.liveswitch.NullVideoSink.processControlFrames ( fm.liveswitch.MediaControlFrame[]  controlFrames)

Processes control frames by raising them.

Parameters
controlFramesThe control frames.

◆ processedFrames()

fm.liveswitch.Future<Object> fm.liveswitch.NullVideoSink.processedFrames ( long  count)

Creates a future that resolves when the specified number of frames have been processed.

Parameters
count

◆ setOutputRtpStreamId()

void fm.liveswitch.NullVideoSink.setOutputRtpStreamId ( String  value)

Sets the output RTP stream identifier.

If the output RTP stream identifier is null (unset), then getting this property returns the InputRtpStreamId.

◆ setOutputSynchronizationSource()

void fm.liveswitch.NullVideoSink.setOutputSynchronizationSource ( long  value)

Sets the output synchronization source.

If the output synchronization source is -1 (unset), then getting this property returns the InputSynchronizationSource.

◆ updateMaxInputBitrate()

void fm.liveswitch.NullVideoSink.updateMaxInputBitrate ( int  maxInputBitrate)

Sets the maximum allowed input bitrate, in kbps.

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

Parameters
maxInputBitrateThe maximum allowed input bitrate, in kbps.

◆ updateMaxInputEncoding()

void fm.liveswitch.NullVideoSink.updateMaxInputEncoding ( fm.liveswitch.EncodingInfo  maxInputEncoding)

Sets the maximum allowed input encoding.

A value of null indicates unset (no maximum).

Parameters
maxInputEncodingThe maximum allowed input encoding.

◆ updateMaxInputFrameRate()

void fm.liveswitch.NullVideoSink.updateMaxInputFrameRate ( double  maxInputFrameRate)

Sets the maximum allowed input frame-rate.

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

Parameters
maxInputFrameRateThe maximum allowed input frame-rate.

◆ updateMaxInputScale()

void fm.liveswitch.NullVideoSink.updateMaxInputScale ( double  maxInputScale)

Sets the maximum allowed input scale.

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

Parameters
maxInputScaleThe maximum allowed input scale.

◆ updateMaxInputSize()

void fm.liveswitch.NullVideoSink.updateMaxInputSize ( fm.liveswitch.Size  maxInputSize)

Sets the maximum allowed input size.

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

Parameters
maxInputSizeThe maximum allowed input size.

◆ updateMinInputBitrate()

void fm.liveswitch.NullVideoSink.updateMinInputBitrate ( int  minInputBitrate)

Sets the minimum allowed input bitrate, in kbps.

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

Parameters
minInputBitrateThe minimum allowed input bitrate, in kbps.

◆ updateMinInputEncoding()

void fm.liveswitch.NullVideoSink.updateMinInputEncoding ( fm.liveswitch.EncodingInfo  minInputEncoding)

Sets the minimum allowed input encoding.

A value of null indicates unset (no minimum).

Parameters
minInputEncodingThe minimum allowed input encoding.

◆ updateMinInputFrameRate()

void fm.liveswitch.NullVideoSink.updateMinInputFrameRate ( double  minInputFrameRate)

Sets the minimum allowed input frame-rate.

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

Parameters
minInputFrameRateThe minimum allowed input frame-rate.

◆ updateMinInputScale()

void fm.liveswitch.NullVideoSink.updateMinInputScale ( double  minInputScale)

Sets the minimum allowed input scale.

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

Parameters
minInputScaleThe minimum allowed input scale.

◆ updateMinInputSize()

void fm.liveswitch.NullVideoSink.updateMinInputSize ( fm.liveswitch.Size  minInputSize)

Sets the minimum allowed input size.

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

Parameters
minInputSizeThe minimum allowed input size.

◆ updateSystemDelay()

void fm.liveswitch.NullVideoSink.updateSystemDelay ( long  systemDelay)

Sets the system delay in ticks.

Parameters
systemDelayThe system delay.

◆ updateVideoType()

void fm.liveswitch.NullVideoSink.updateVideoType ( fm.liveswitch.VideoType  videoType)

Sets the video type.

Parameters
videoTypeThe video type.