PropertyKey

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 PropertyKey

    Object
      com.epiphan.vga2usb.Enum
          com.epiphan.vga2usb.Enum.Int
              com.epiphan.vga2usb.PropertyKey

All Implemented Interfaces:
  Comparable

public final class PropertyKey
extends com.epiphan.vga2usb.Enum.Int

Typesafe enumeration of property keys.

Field Summary
`static PropertyKey` | `DeviceCaps` Device capabilities.
`static PropertyKey` | `DirectShowDefaultBmp` GET/SET [wstr], Windows only
`static PropertyKey` | `DirectShowFixRes` Fixed resolution for DirectShow stream (Windows only).
`static PropertyKey` | `DirectShowFlags` DirectShow stream (Windows only).
`static PropertyKey` | `DirectShowMaxFps` GET/SET [uint32], Windows only
`static PropertyKey` | `DirectShowScaleMode` GET/SET [scale], Windows only
`static PropertyKey` | `HardwareCompression` GET only [boolean]
`static PropertyKey` | `InputSignalType` Type of the input signal.
`static PropertyKey` | `KVMCapable` GET only [boolean]
`static PropertyKey` | `ProductName` GET only [string]
`static PropertyKey` | `SerialNumber` GET only [string]

Method Summary
`int` | `compareTo(int key)` Compares id of this object with the specified key for order.
`int` | `compareTo(Object obj)` Compares this object with the specified object for order.
`String` | `getDescription()` Returns the description of this object.
`PropertyType` | `getType()` Gets the property type
`int` | `getValue()` Gets the integer value associated with this object.
`int` | `hashCode()` Returns the hashcode for this object.
`protected static int` | `search(java.util.List list, int key)` Searches the list for the specified enum object using the binary search algorithm.
`String` | `toString()` Returns a string representation of this object.

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

Field Detail

### DeviceCaps

    public static final PropertyKey DeviceCaps

  Device capabilities.
  GET only [uint32].
  The following capability bits are currently defined:

  `CAPS_VGA_CAPTURE` | Captures VGA signal
  `CAPS_DVI_CAPTURE` | Captures DVI single-link
  `CAPS_DVI_DUAL_LINK` | Captures DVI dual-link
  `CAPS_KVM` | KVM functionality
  `CAPS_EDID` | Programmable EDID
  `CAPS_HW_COMPRESSION` | On-board compression
  `CAPS_SYNC_THRESHOLD` | Adjustable sync thresholds
  `CAPS_HW_SCALE` | Hardware scale

### DirectShowDefaultBmp

    public static final PropertyKey DirectShowDefaultBmp

  GET/SET [wstr], Windows only

### DirectShowFixRes

    public static final PropertyKey DirectShowFixRes

  Fixed resolution for DirectShow stream (Windows only).
  GET/SET [size]

### DirectShowFlags

    public static final PropertyKey DirectShowFlags

  DirectShow stream (Windows only).
  GET/SET [uint32]

  See Also:
    `DSHOW_LIMIT_FPS`, `DSHOW_FLIP_VERTICALLY`, `DSHOW_FIX_FPS`

### DirectShowMaxFps

    public static final PropertyKey DirectShowMaxFps

  GET/SET [uint32], Windows only

### DirectShowScaleMode

    public static final PropertyKey DirectShowScaleMode

  GET/SET [scale], Windows only

  Since:
    3.27.1

### HardwareCompression

    public static final PropertyKey HardwareCompression

  GET only [boolean]

### InputSignalType

    public static final PropertyKey InputSignalType

  Type of the input signal.
  GET only [uint32].

  See Also:
    `INPUT_ANALOG`, `INPUT_DIGITAL`, `INPUT_SOG`, `INPUT_COMPOSITE`

### KVMCapable

    public static final PropertyKey KVMCapable

  GET only [boolean]

### ProductName

    public static final PropertyKey ProductName

  GET only [string]

### SerialNumber

    public static final PropertyKey SerialNumber

  GET only [string]

Method Detail

### getType

    public PropertyType getType()

  Gets the property type

  Returns:
    the property type

### compareTo

    public int compareTo(int key)

  Compares id of this object with the specified key for order. Returns a negative integer, zero, or a positive integer as id of this object is less than, equal to, or greater than the specified key.

  Parameters:
    `key` - the key to be compared.
  Returns:
    a negative integer, zero, or a positive integer as id of this object is less than, equal to, or greater than the specified key.
  Throws:
    `ClassCastException` - if the specified object's type prevents it from being compared to this Object.
  See Also:
    `Comparable`

### compareTo

    public int compareTo(Object obj)

  Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

  Specified by:
    `compareTo` in interface `Comparable`
  Parameters:
    `obj` - the Object to be compared.
  Returns:
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
  Throws:
    `ClassCastException` - if the specified object's type prevents it from being compared to this Object.
  See Also:
    `Comparable`

### getValue

    public final int getValue()

  Gets the integer value associated with this object.

  Returns:
    The integer value that identifies this object

### hashCode

    public final int hashCode()

  Returns the hashcode for this object.

  Returns:
    The hashcode for this object.

### search

    protected static int search(java.util.List list,
                                int key)

  Searches the list for the specified enum object using the binary search algorithm. The list must be sorted.

  Parameters:
    `list` - the list to search
    `key` - the key to search for
  Returns:
    index of the enum object, if it is contained in the list; otherwise, `(-(insertion point) - 1)`.

### getDescription

    public final String getDescription()

  Returns the description of this object.

  Returns:
    The description of this object.

### toString

    public final 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.