Configurable (humble-video-noarch 0.3.0 API)

java.lang.Object
- io.humble.ferry.RefCounted
- - io.humble.video.Configurable

Direct Known Subclasses:

Coder, Container, Filter, FilterGraph, MediaResampler
```
public class Configurable
extends RefCounted
```
Methods that implement this class can be configured
using setProperty and getProperty methods, and expose
IProperty meta data about their properties.

You can use Configuration#configure(java.util.Properties, Configurable)
to easily configure these objects from Java properties or
from a FFmpeg preset file.

Author:

aclarke

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Configurable`	`copyReference()` Create a new Configurable object that is actually referring to the exact same underlying native object.
`boolean`	`equals(Object obj)` Compares two values, returning true if the underlying objects in native code are the same object.
`int`	`getNumProperties()` Returns the total number of settable properties on this object
`boolean`	`getPropertyAsBoolean(String name)` Gets the value of this property, and returns as a boolean
`double`	`getPropertyAsDouble(String name)` Gets the value of this property, and returns as a double;
`int`	`getPropertyAsInt(String name)` Gets the value of this property, and returns as an int;
`long`	`getPropertyAsLong(String name)` Gets the value of this property, and returns as an long;
`Rational`	`getPropertyAsRational(String name)` Gets the value of this property, and returns as an Rational;
`String`	`getPropertyAsString(String name)` Gets a property on this Object.
`Property`	`getPropertyMetaData(int propertyNo)` Returns the name of the numbered property.
`Property`	`getPropertyMetaData(String name)` Returns the name of the named property.
`int`	`hashCode()` Get a hashable value for this object.
`void`	`setProperty(KeyValueBag valuesToSet, KeyValueBag valuesNotFound)` Sets all properties in valuesToSet on this Configurable object.
`void`	`setProperty(String name, boolean value)` Looks up the property 'name' and sets the value of the property to 'value'.
`void`	`setProperty(String name, double value)` Looks up the property 'name' and sets the value of the property to 'value'.
`void`	`setProperty(String name, long value)` Looks up the property 'name' and sets the value of the property to 'value'.
`void`	`setProperty(String name, Rational value)` Looks up the property 'name' and sets the value of the property to 'value'.
`void`	`setProperty(String name, String value)` Sets a property on this Object. All AVOptions supported by the underlying AVClass are supported.

Methods inherited from class io.humble.ferry.RefCounted
delete, getCurrentRefCount

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - copyReference
```
public Configurable copyReference()
```
    Create a new Configurable object that is actually referring to the exact same underlying native object.
    
    Overrides:
    
    copyReference in class RefCounted
    
    Returns:
    
    the new Java object.
  - equals
```
public boolean equals(Object obj)
```
    Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    True if the underlying native object is the same. False otherwise.
  - hashCode
```
public int hashCode()
```
    Get a hashable value for this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hashable value.
  - getNumProperties
```
public int getNumProperties()
```
    Returns the total number of settable properties on this object
    
    Returns:
    
    total number of options (not including constant definitions)
  - getPropertyMetaData
```
public Property getPropertyMetaData(int propertyNo)
```
    Returns the name of the numbered property.
    
    Parameters:
    
    propertyNo - The property number in the options list.
    
    Returns:
    
    a Property value for this properties meta-data
  - getPropertyMetaData
```
public Property getPropertyMetaData(String name)
```
    Returns the name of the named property.
    
    Parameters:
    
    name - The property name.
    
    Returns:
    
    a Property value for this properties meta-data
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - setProperty
```
public void setProperty(String name,
                        String value)
```
    Sets a property on this Object.
    
    All AVOptions supported by the underlying AVClass are supported.
    
    Parameters:
    
    name - The property name. For example "b" for bit-rate.
    
    value - The value of the property.
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - setProperty
```
public void setProperty(String name,
                        double value)
```
    Looks up the property 'name' and sets the
    value of the property to 'value'.
    
    Parameters:
    
    name - name of option
    
    value - Value of option
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - setProperty
```
public void setProperty(String name,
                        long value)
```
    Looks up the property 'name' and sets the
    value of the property to 'value'.
    
    Parameters:
    
    name - name of option
    
    value - Value of option
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - setProperty
```
public void setProperty(String name,
                        boolean value)
```
    Looks up the property 'name' and sets the
    value of the property to 'value'.
    
    Parameters:
    
    name - name of option
    
    value - Value of option
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - setProperty
```
public void setProperty(String name,
                        Rational value)
```
    Looks up the property 'name' and sets the
    value of the property to 'value'.
    
    Parameters:
    
    name - name of option
    
    value - Value of option
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - getPropertyAsString
```
public String getPropertyAsString(String name)
```
    Gets a property on this Object.
    
    Parameters:
    
    name - property name
    
    Returns:
    
    a string copy of the option value.
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - getPropertyAsDouble
```
public double getPropertyAsDouble(String name)
```
    Gets the value of this property, and returns as a double;
    
    Parameters:
    
    name - name of option
    
    Returns:
    
    double value of property.
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - getPropertyAsLong
```
public long getPropertyAsLong(String name)
```
    Gets the value of this property, and returns as an long;
    
    Parameters:
    
    name - name of option
    
    Returns:
    
    long value of property.
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - getPropertyAsInt
```
public int getPropertyAsInt(String name)
```
    Gets the value of this property, and returns as an int;
    
    Parameters:
    
    name - name of option
    
    Returns:
    
    int value of property.
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - getPropertyAsRational
```
public Rational getPropertyAsRational(String name)
```
    Gets the value of this property, and returns as an Rational;
    
    Parameters:
    
    name - name of option
    
    Returns:
    
    long value of property.
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - getPropertyAsBoolean
```
public boolean getPropertyAsBoolean(String name)
```
    Gets the value of this property, and returns as a boolean
    
    Parameters:
    
    name - name of option
    
    Returns:
    
    boolean value of property.
    
    Throws:
    
    PropertyNotFoundException - if this property is not found.
  - setProperty
```
public void setProperty(KeyValueBag valuesToSet,
                        KeyValueBag valuesNotFound)
```
    Sets all properties in valuesToSet on this Configurable object.
    
    Parameters:
    
    valuesToSet - The set of key-value pairs to try to set
    
    valuesNotFound - If non null will contain all key-values pairs in valuesToSet
    that were not found in context.

Class Configurable

Method Summary

Methods inherited from class io.humble.ferry.RefCounted

Methods inherited from class java.lang.Object

Method Detail

copyReference

equals

hashCode

getNumProperties

getPropertyMetaData

getPropertyMetaData

setProperty

setProperty

setProperty

setProperty

setProperty

getPropertyAsString

getPropertyAsDouble

getPropertyAsLong

getPropertyAsInt

getPropertyAsRational

getPropertyAsBoolean

setProperty