FrameData (MDSplus jScope 7.138.0 API)

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

See Also:

DataProvider

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AWT_IMAGE`
`static int`	`BITMAP_IMAGE_16`
`static int`	`BITMAP_IMAGE_32`
`static int`	`BITMAP_IMAGE_8`
`static int`	`BITMAP_IMAGE_F32`
`static int`	`BITMAP_IMAGE_U16`
`static int`	`BITMAP_IMAGE_U32`
`static int`	`BITMAP_IMAGE_U8`
`static int`	`JAI_IMAGE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`byte[]`	`getFrameAt(int idx)` Return the frame at the given position.
`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 the number of frames in the sequence.

- Field Detail
  - AWT_IMAGE
```
static final int AWT_IMAGE
```
    See Also:
    
    Constant Field Values
  - BITMAP_IMAGE_16
```
static final int BITMAP_IMAGE_16
```
    See Also:
    
    Constant Field Values
  - BITMAP_IMAGE_32
```
static final int BITMAP_IMAGE_32
```
    See Also:
    
    Constant Field Values
  - BITMAP_IMAGE_8
```
static final int BITMAP_IMAGE_8
```
    See Also:
    
    Constant Field Values
  - BITMAP_IMAGE_F32
```
static final int BITMAP_IMAGE_F32
```
    See Also:
    
    Constant Field Values
  - BITMAP_IMAGE_U16
```
static final int BITMAP_IMAGE_U16
```
    See Also:
    
    Constant Field Values
  - BITMAP_IMAGE_U32
```
static final int BITMAP_IMAGE_U32
```
    See Also:
    
    Constant Field Values
  - BITMAP_IMAGE_U8
```
static final int BITMAP_IMAGE_U8
```
    See Also:
    
    Constant Field Values
  - JAI_IMAGE
```
static final int JAI_IMAGE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getFrameAt
```
byte[] getFrameAt(int idx)
           throws 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:
    
    IOException
  - getFrameDimension
```
Dimension getFrameDimension()
                     throws Exception
```
    Return the dimension of a frame. All the frames in the sequence must have the same dimension.
    
    Returns:
    
    The frame dimension.
    
    Throws:
    
    IOException
    
    Exception
  - getFrameTimes
```
float[] getFrameTimes()
               throws Exception
```
    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:
    
    Exception
  - getFrameType
```
int getFrameType()
          throws Exception
```
    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.
    -FrameData.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.
    Currently, only BITMAP_IMAGE is supported
    
    Returns:
    
    The type of the corresponding frame.
    
    Throws:
    
    IOException
    
    Exception
  - getNumFrames
```
int getNumFrames()
          throws Exception
```
    Returns the number of frames in the sequence.
    
    Returns:
    
    The number of frames in the sequence.
    
    Throws:
    
    IOException
    
    Exception

Interface FrameData

Field Summary

Method Summary

Field Detail

AWT_IMAGE

BITMAP_IMAGE_16

BITMAP_IMAGE_32

BITMAP_IMAGE_8

BITMAP_IMAGE_F32

BITMAP_IMAGE_U16

BITMAP_IMAGE_U32

BITMAP_IMAGE_U8

JAI_IMAGE

Method Detail

getFrameAt

getFrameDimension

getFrameTimes

getFrameType

getNumFrames