Interface FrameData

public interface FrameData

When a Frame sequence is requested to a DataProvider implementation, it is returned by means of an object implemenmting the FrameData interface. FrameData defines therefore all the access methods required to handle a sequence of frames.

See Also:

DataProvider

Field Summary
static int	AWT_IMAGE
static int	BITMAP_IMAGE
static int	JAI_IMAGE

 

Method Summary
byte[]	GetFrameAt(int idx)           Return the frame at the given position.
java.awt.Dimension	GetFrameDimension()           Return the dimension of a frame.
float[]	GetFrameTimes()           Return the times associated with every frame of the sequence.
int	GetFrameType()           Returns the type of the corresponding frames.
int	GetNumFrames()           Returns thenumber of frames in the sequence.

 

Field Detail

BITMAP_IMAGE

public static final int BITMAP_IMAGE

AWT_IMAGE

public static final int AWT_IMAGE

JAI_IMAGE

public static final int JAI_IMAGE

GetFrameType

public int GetFrameType()
                 throws java.io.IOException

Returns the type of the corresponding frames. Returned frames can have either of the following types:
-FrameData.BITMAP_IMAGE meaning that method GetFrameAt will return a byte matrix.
-FrameData.AWT_IMAGE meaning that method GetFrameAt will return a byte vector representing the binary content of a gif or jpeg file.
-FramDeata.JAI_IMAGE meaning that method GetFrameAt will return a byte vector representing the binary content of every image file supported by the JAI (Java Advanced Imaging) package. The JAI package needs not to be installed unless file formats other than gif or jpeg are used.

Returns:

The type of the corresponding frame.

Throws:

java.io.IOException -  

GetNumFrames

public int GetNumFrames()
                 throws java.io.IOException

Returns thenumber of frames in the sequence.

Returns:

The number of frames in the sequence.

Throws:

java.io.IOException -  

GetFrameDimension

public java.awt.Dimension GetFrameDimension()
                                     throws java.io.IOException

Return the dimension of a frame. All the frames in the sequence must have the same dimension.

Returns:

The frame dimension.

Throws:

java.io.IOException -  

GetFrameTimes

public float[] GetFrameTimes()
                      throws java.io.IOException

Return the times associated with every frame of the sequence. This information is required to correlate the frame sequence with the other signals displayed by jScope.

Returns:

The time array for the frame sequence.

Throws:

java.io.IOException -  

GetFrameAt

public byte[] GetFrameAt(int idx)
                  throws java.io.IOException

Return the frame at the given position.

Parameters:

idx - The index of the requested frame in the frame sequence.

Returns:

The frame as a byte array. If the frame type is FrameData.BITMAP_IMAGE, the matrix uses row major ordering.

Throws:

java.io.IOException -