Grabber

Package | Class | Use | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.epiphan.vga2usb
Class Grabber

    Object
      com.epiphan.vga2usb.Grabber

public class Grabber
extends Object

Java interface to Epiphan frame grabbers.

Constructor Summary
`Grabber()` Opens any available VGA2USB device.
`Grabber(java.net.InetAddress address)` Open network frame grabber at the specified address.
`Grabber(int id)` Opens a VGA2USB device.
`Grabber(String sn)` Open VGA2USB device with the specified serial number.

Method Summary
`void` | `close()` Closes the device.
`VideoMode` | `detectVideoMode()` Detects video mode.
`protected void` | `finalize()` Invoked when this object is being garbage collected
`boolean` | `getBooleanProperty(PropertyKey key)` Gets the value of a boolean property.
`DeviceType` | `getDeviceType()` Get the type of this frame grabber.
`int` | `getEnumProperty(PropertyKey key)` Gets the value of the specified enum property.
`GrabParameters` | `getGrabParameters()` Gets VGA capture parameters.
`int` | `getIntProperty(PropertyKey key)` Gets the value of the specified integer property.
`Size` | `getSizeProperty(PropertyKey key)` Gets the value of the specified enum property.
`String` | `getSN()` Gets serial number string for this device.
`String` | `getStringProperty(PropertyKey key)` Gets the value of a string property.
`Frame` | `grabFrame()` Grabs a single frame.
`RawFrame` | `grabRawFrame(PixelFormat format, boolean bottomUp)` Grabs a single frame.
`boolean` | `isKVMCapable()` Tests whether this grabber is some kind of KVM2USB.
`void` | `setEnumProperty(PropertyKey key, com.epiphan.vga2usb.Enum.Int value)` Sets the value of the specified enum property.
`void` | `setGrabParameters(GrabParameters gp)` Sets VGA capture parameters.
`void` | `setIntProperty(PropertyKey key, int value)` Sets the value of the specified integer property.
`void` | `setSizeProperty(PropertyKey key, Size value)` Sets the value of the specified enum property.
`void` | `setStringProperty(PropertyKey key, String value)` Sets the value of the specified string property.
`void` | `start()` Prepares frame grabber for capture with maximum possible frame rate.
`void` | `stop()` Signals the driver that maximum possible frame rate is no longer required.
`String` | `toString()` Returns a string representation of this object.

Methods inherited from class Object
`clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### Grabber

    public Grabber()
            throws IOException

  Opens any available VGA2USB device.

Throws:
  `IOException` - if the device can't be opened

### Grabber

    public Grabber(java.net.InetAddress address)
            throws IOException

  Open network frame grabber at the specified address.

Parameters:
  `address` - IP address of the device to open.
Throws:
  `IOException` - if the device can't be opened
Since:
  3.20.18

### Grabber

    public Grabber(int id)
            throws IOException

  Opens a VGA2USB device.

Parameters:
  `id` - which device to open.
Throws:
  `IOException` - if the device can't be opened

### Grabber

    public Grabber(String sn)
            throws IOException

  Open VGA2USB device with the specified serial number.

Parameters:
  `sn` - serial number of the device to open.
Throws:
  `IOException` - if the device can't be opened

Method Detail

### close

    public void close()

  Closes the device.

### detectVideoMode

    public VideoMode detectVideoMode()
                              throws IOException

  Detects video mode.

  Returns:
    the video mode descriptor, or `null` if no signal was detected.
  Throws:
    `IOException` - if an I/O error occurs.

### finalize

    protected void finalize()
                     throws Throwable

  Invoked when this object is being garbage collected

  Throws:
    `Throwable` - any exception that occurs during finalization

### getBooleanProperty

    public boolean getBooleanProperty(PropertyKey key)
                               throws IOException

  Gets the value of a boolean property.

  Parameters:
    `key` - The property key.
  Returns:
    The value of the requested property.
  Throws:
    `IOException` - if an I/O error occurs.
  Since:
    3.20.15

### getDeviceType

    public DeviceType getDeviceType()

  Get the type of this frame grabber.

  Returns:
    The type of this frame grabber.

### getEnumProperty

    public int getEnumProperty(PropertyKey key)
                        throws IOException

  Gets the value of the specified enum property.

  Parameters:
    `key` - The property key
  Returns:
    The current property value.
  Throws:
    `IOException` - if an I/O error occurs.
  Since:
    3.27.1

### getGrabParameters

    public GrabParameters getGrabParameters()
                                     throws IOException

  Gets VGA capture parameters.

  Returns:
    the current grab parameters
  Throws:
    `IOException` - if an I/O error occurs
  Since:
    3.22.2

### getIntProperty

    public int getIntProperty(PropertyKey key)
                       throws IOException

  Gets the value of the specified integer property.

  Parameters:
    `key` - The property key
  Returns:
    The current property value.
  Throws:
    `IOException` - if an I/O error occurs.
  Since:
    3.27.1

### getSizeProperty

    public Size getSizeProperty(PropertyKey key)
                         throws IOException

  Gets the value of the specified enum property.

  Parameters:
    `key` - The property key
  Returns:
    The current property value.
  Throws:
    `IOException` - if an I/O error occurs.
  Since:
    3.27.1

### getSN

    public String getSN()
                           throws IOException

  Gets serial number string for this device.

  Returns:
    The serial number string.
  Throws:
    `IOException` - if an I/O error occurs.

### getStringProperty

    public String getStringProperty(PropertyKey key)
                                       throws IOException

  Gets the value of a string property.

  Parameters:
    `key` - The property key.
  Returns:
    The value of the requested property.
  Throws:
    `IOException` - if an I/O error occurs.
  Since:
    3.22.2

### grabFrame

    public Frame grabFrame()
                    throws IOException

  Grabs a single frame.

  Returns:
    The captured frame, or `null` if there's no signal.
  Throws:
    `IOException` - if an I/O error occurs.
  See Also:
    `grabRawFrame(PixelFormat,boolean)`

### grabRawFrame

    public RawFrame grabRawFrame(PixelFormat format,
                                 boolean bottomUp)
                          throws IOException

  Grabs a single frame. Raw frame is essentially nothing mode than a byte array. It's up to the caller what to do with it.

  Parameters:
    `format` - the desired pixel format.
    `bottomUp` - if `true`, then image lines will be in bottom-up order (default is up-down).
  Returns:
    Raw captured frame in the requested format, or `null` if there's no signal.
  Throws:
    `IOException` - if an I/O error occurs.
  See Also:
    `grabFrame()`

### isKVMCapable

    public boolean isKVMCapable()

  Tests whether this grabber is some kind of KVM2USB.

  Returns:
    `true` if this grabber supports KVM functionality, `false` otherwise.
  Since:
    3.20.15

### setEnumProperty

    public void setEnumProperty(PropertyKey key,
                                com.epiphan.vga2usb.Enum.Int value)
                         throws IOException

  Sets the value of the specified enum property.

  Parameters:
    `key` - The property key
    `value` - The desired property value
  Throws:
    `IOException` - if an I/O error occurs.
  Since:
    3.27.1

### setGrabParameters

    public void setGrabParameters(GrabParameters gp)
                           throws IOException

  Sets VGA capture parameters.

  Parameters:
    `gp` - grab parameters
  Throws:
    `IOException` - if an I/O error occurs
  Since:
    3.22.2

### setIntProperty

    public void setIntProperty(PropertyKey key,
                               int value)
                        throws IOException

  Sets the value of the specified integer property.

  Parameters:
    `key` - The property key
    `value` - The desired property value
  Throws:
    `IOException` - if an I/O error occurs.
  Since:
    3.27.1

### setSizeProperty

    public void setSizeProperty(PropertyKey key,
                                Size value)
                         throws IOException

  Sets the value of the specified enum property.

  Parameters:
    `key` - The property key
    `value` - The desired property value
  Throws:
    `IOException` - if an I/O error occurs.
  Since:
    3.27.1

### setStringProperty

    public void setStringProperty(PropertyKey key,
                                  String value)
                           throws IOException

  Sets the value of the specified string property.

  Parameters:
    `key` - The property key
    `value` - The property value
  Throws:
    `IOException` - if an I/O error occurs
  Since:
    3.27.1

### start

    public void start()
               throws IOException

  Prepares frame grabber for capture with maximum possible frame rate. Especially useful for network frame grabbers.

  Throws:
    `IOException` - if an I/O error occurs
  Since:
    3.26.2

### stop

    public void stop()
              throws IOException

  Signals the driver that maximum possible frame rate is no longer required. Especially useful for network frame grabbers (reduces network usage).

  Throws:
    `IOException` - if an I/O error occurs
  Since:
    3.26.2

### toString

    public String toString()

  Returns a string representation of this object. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be `null`.

  Returns:
    A string representation of this object.

Package | Class | Use | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008-2012 Epiphan Systems Inc. All rights reserved.