Package edu.wpi.first.cscore

Class VideoProperty

java.lang.Object
edu.wpi.first.cscore.VideoProperty
public class VideoProperty extends Object
A source or sink property.

  • Method Details

    • getKindFromInt

      public static VideoProperty.Kind getKindFromInt(int kind)
      Convert from the numerical representation of kind to an enum type.
      Parameters:
      kind - The numerical representation of kind
      Returns:
      The kind

    • getName

      public String getName()
      Returns property name.
      Returns:
      Property name.

    • getKind

      public VideoProperty.Kind getKind()
      Returns property kind.
      Returns:
      Property kind.

    • isValid

      public boolean isValid()
      Returns true if property is valid.
      Returns:
      True if property is valid.

    • isBoolean

      public boolean isBoolean()
      Returns true if property is a boolean.
      Returns:
      True if property is a boolean.

    • isInteger

      public boolean isInteger()
      Returns true if property is an integer.
      Returns:
      True if property is an integer.

    • isString

      public boolean isString()
      Returns true if property is a string.
      Returns:
      True if property is a string.

    • isEnum

      public boolean isEnum()
      Returns true if property is an enum.
      Returns:
      True if property is an enum.

    • get

      public int get()
      Returns property value.
      Returns:
      Property value.

    • set

      public void set(int value)
      Sets property value.
      Parameters:
      value - Property value.

    • getMin

      public int getMin()
      Returns property minimum value.
      Returns:
      Property minimum value.

    • getMax

      public int getMax()
      Returns property maximum value.
      Returns:
      Property maximum value.

    • getStep

      public int getStep()
      Returns property step size.
      Returns:
      Property step size.

    • getDefault

      public int getDefault()
      Returns property default value.
      Returns:
      Property default value.

    • getString

      public String getString()
      Returns the string property value.

      This function is string-specific.

      Returns:
      The string property value.

    • setString

      public void setString(String value)
      Sets the string property value.

      This function is string-specific.

      Parameters:
      value - String property value.

    • getChoices

      public String[] getChoices()
      Returns the possible values for the enum property value.

      This function is enum-specific.

      Returns:
      The possible values for the enum property value.