fm.liveswitch.yuv4mpeg.VideoSource Class Reference

A YUV4MPEG-file-based video source. More...

Public Member Functions

void addOnEnded (fm.liveswitch.IAction0 value)
 Adds a handler that is raised when the file ends. More...
 
String getLabel ()
 Gets the label. More...
 
String getPath ()
 Gets the path. More...
 
void removeOnEnded (fm.liveswitch.IAction0 value)
 Removes a handler that is raised when the file ends. More...
 
 VideoSource (String path)
 Initializes a new instance of the fm.liveswitch.yuv4mpeg.VideoSource class. 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...
 
double getMaxOutputFrameRate ()
 Gets the maximum allowed output frame-rate, in fps. More...
 
int getMaxOutputHeight ()
 Gets the maximum allowed output height. More...
 
double getMaxOutputScale ()
 Gets the maximum allowed output scale. More...
 
fm.liveswitch.Size getMaxOutputSize ()
 Gets the maximum allowed output size. More...
 
int getMaxOutputWidth ()
 Gets the maximum allowed output width. More...
 
fm.liveswitch.EncodingInfo getMinOutputEncoding ()
 Gets the minimum allowed output encoding. More...
 
double getMinOutputFrameRate ()
 Gets the minimum allowed output frame-rate, in fps. More...
 
int getMinOutputHeight ()
 Gets the minimum allowed output height. More...
 
double getMinOutputScale ()
 Gets the minimum allowed output scale. More...
 
fm.liveswitch.Size getMinOutputSize ()
 Gets the minimum allowed output size. 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...
 
double getTargetOutputFrameRate ()
 Gets the target output frame-rate, in fps. More...
 
int getTargetOutputHeight ()
 Gets the target output height. More...
 
double getTargetOutputScale ()
 Gets the target output scale. More...
 
fm.liveswitch.Size getTargetOutputSize ()
 Gets the target output size. 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 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.Future< Object > doStart ()
 Starts the source. More...
 
fm.liveswitch.Future< Object > doStop ()
 Stops the source. 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 setMaxOutputFrameRate (double value)
 Sets the maximum allowed output frame-rate, in fps. More...
 
void setMaxOutputScale (double value)
 Sets the maximum allowed output scale. More...
 
void setMaxOutputSize (fm.liveswitch.Size value)
 Sets the maximum allowed output size. More...
 
void setMinOutputEncoding (fm.liveswitch.EncodingInfo value)
 Sets the minimum allowed output encoding. More...
 
void setMinOutputFrameRate (double value)
 Sets the minimum allowed output frame-rate, in fps. More...
 
void setMinOutputScale (double value)
 Sets the minimum allowed output scale. More...
 
void setMinOutputSize (fm.liveswitch.Size value)
 Sets the minimum allowed output size. More...
 
void setTargetOutputEncoding (fm.liveswitch.EncodingInfo value)
 Sets the target output encoding. More...
 
void setTargetOutputFrameRate (double value)
 Sets the target output frame-rate, in fps. More...
 
void setTargetOutputScale (double value)
 Sets the target output scale. More...
 
void setTargetOutputSize (fm.liveswitch.Size value)
 Sets the target output size. More...
 
void setVideoType (fm.liveswitch.VideoType value)
 Sets the video type. More...
 
- Protected Member Functions inherited from fm.liveswitch.MediaSourceBase
 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 YUV4MPEG-file-based video source.

Constructor & Destructor Documentation

◆ VideoSource()

fm.liveswitch.yuv4mpeg.VideoSource.VideoSource ( String  path)

Initializes a new instance of the fm.liveswitch.yuv4mpeg.VideoSource class.

Parameters
pathThe path.

Member Function Documentation

◆ addOnEnded()

void fm.liveswitch.yuv4mpeg.VideoSource.addOnEnded ( fm.liveswitch.IAction0  value)

Adds a handler that is raised when the file ends.

◆ doStart()

fm.liveswitch.Future<Object> fm.liveswitch.yuv4mpeg.VideoSource.doStart ( )
protected

Starts the source.

◆ doStop()

fm.liveswitch.Future<Object> fm.liveswitch.yuv4mpeg.VideoSource.doStop ( )
protected

Stops the source.

◆ getLabel()

String fm.liveswitch.yuv4mpeg.VideoSource.getLabel ( )

Gets the label.

Implements fm.liveswitch.IMediaElement.

◆ getPath()

String fm.liveswitch.yuv4mpeg.VideoSource.getPath ( )

Gets the path.

◆ removeOnEnded()

void fm.liveswitch.yuv4mpeg.VideoSource.removeOnEnded ( fm.liveswitch.IAction0  value)

Removes a handler that is raised when the file ends.