fm.liveswitch.VideoFrame Class Reference

A video frame. More...

Public Member Functions

fm.liveswitch.VideoFrame clone ()
 Clones this instance. More...
 
fm.liveswitch.VideoFrame createInstance ()
 Creates a new instance. More...
 
String toString ()
 Returns a string that represents this instance. More...
 
 VideoFrame ()
 Initializes a new instance of the fm.liveswitch.VideoFrame class. More...
 
 VideoFrame (fm.liveswitch.VideoBuffer buffer)
 Initializes a new instance of the fm.liveswitch.VideoFrame class. More...
 
 VideoFrame (fm.liveswitch.VideoBuffer[] buffers)
 Initializes a new instance of the fm.liveswitch.VideoFrame class. 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...
 

Static Public Member Functions

static fm.liveswitch.VideoFrame generateFrame (int width, int height, String formatName)
 Generates a black video frame for the given width, height, and format. More...
 

Protected Member Functions

fm.liveswitch.VideoBufferCollection createMediaBufferCollection ()
 Creates a media buffer collection. More...
 
- 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 frame.

Constructor & Destructor Documentation

◆ VideoFrame() [1/3]

fm.liveswitch.VideoFrame.VideoFrame ( )

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

◆ VideoFrame() [2/3]

fm.liveswitch.VideoFrame.VideoFrame ( fm.liveswitch.VideoBuffer  buffer)

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

Parameters
bufferThe buffer.

◆ VideoFrame() [3/3]

fm.liveswitch.VideoFrame.VideoFrame ( fm.liveswitch.VideoBuffer[]  buffers)

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

Parameters
buffersThe buffers.

Member Function Documentation

◆ clone()

fm.liveswitch.VideoFrame fm.liveswitch.VideoFrame.clone ( )

Clones this instance.

◆ createInstance()

fm.liveswitch.VideoFrame fm.liveswitch.VideoFrame.createInstance ( )

Creates a new instance.

◆ createMediaBufferCollection()

fm.liveswitch.VideoBufferCollection fm.liveswitch.VideoFrame.createMediaBufferCollection ( )
protected

Creates a media buffer collection.

◆ generateFrame()

static fm.liveswitch.VideoFrame fm.liveswitch.VideoFrame.generateFrame ( int  width,
int  height,
String  formatName 
)
static

Generates a black video frame for the given width, height, and format.

Parameters
widthThe width.
heightThe height.
formatNameThe format name.

◆ toString()

String fm.liveswitch.VideoFrame.toString ( )

Returns a string that represents this instance.