C++ Java Unity
Java Reference
Frame Class Reference
Inheritance diagram for Frame:

Public Member Functions

Frame clone ()
 Returns a shallow copy of this Frame object that is valid beyond the context of the original object. More...
 
boolean equals (Object obj)
 
 Frame ()
 Creates a new frame. More...
 
 Frame (Frame other)
 Creates new references to an existing frame's data. More...
 
double getTimeStamp ()
 Get the time stamp (in seconds) of this frame. More...
 
int getIndex ()
 Get the index of this frame. More...
 
ImageList getImages ()
 Read-only access to the list of images in this frame. More...
 

Constructor & Destructor Documentation

Frame ( )

Creates a new frame.

Frame ( Frame  other)

Creates new references to an existing frame's data.

Member Function Documentation

Frame clone ( )

Returns a shallow copy of this Frame object that is valid beyond the context of the original object.

This new state object and it's Image resources will remain until it all references are removed and the object is Garbage Collected.

boolean equals ( Object  obj)
double getTimeStamp ( )

Get the time stamp (in seconds) of this frame.

The time stamp of a frame is the time when the image was captured, independent of when the image buffer itself was created.

The time stamp is measured in seconds, and represents the time elapsed since some reference time. The reference time is platform and device specific, but is usually either the time when the application was launched or the time the device started up.

int getIndex ( )

Get the index of this frame.

ImageList getImages ( )

Read-only access to the list of images in this frame.