io.humble.video

Class Property

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Property

public class Property
extends RefCounted

Represents settable properties that effect how Humble Video objects
operate.

For example, setting the "b" property on an
IStreamCoder sets the bit-rate the coder will attempt
to encode at.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Property.Flags
static class	Property.Search How to search options when looking for different values.
static class	Property.Type The different type of options that are supported by Humble Video. Well, actually by FFMPEG, but you get the idea.

Method Summary

Modifier and Type	Method and Description
Property	copyReference() Create a new Property 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.
long	getDefault() Get the default setting this flag would have it not set.
double	getDefaultAsDouble() Get the default setting this flag would have it not set.
Property	getFlagConstant(int position) If this IProperty is of the type Type#PROPERTY_FLAGS, this method will give you another IProperty representing a constant setting for that flag.
Property	getFlagConstant(String name) If this IProperty is of the type Type#PROPERTY_FLAGS, this method will give you another IProperty representing a constant setting for that flag.
int	getFlags() Get any set flags (a bitmask) for this option.
String	getHelp() Get the (English) help string for this property.
String	getName() Get the name for this property.
int	getNumFlagSettings() If this IProperty is of the type Type#PROPERTY_FLAGS, this method will tell you how many different flag settings it takes.
Property.Type	getType() Get the underlying native type of this property.
String	getUnit() Get any sub-unit this option or constant belongs to.
int	hashCode() Get a hashable value for this object.

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 Property copyReference()

Create a new Property 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.

getName

public String getName()

Get the name for this property.

Returns:

the name.

getHelp

public String getHelp()

Get the (English) help string for this property.

Returns:

the help string

getUnit

public String getUnit()

Get any sub-unit this option or constant belongs to.

Returns:

the unit, or null if none.

getType

public Property.Type getType()

Get the underlying native type of this property.

Returns:

the type

getFlags

public int getFlags()

Get any set flags (a bitmask) for this option.

Returns:

the flags

getDefault

public long getDefault()

Get the default setting this flag would have it not set.

Returns:

the default

getDefaultAsDouble

public double getDefaultAsDouble()

Get the default setting this flag would have it not set.

Returns:

the default

getNumFlagSettings

public int getNumFlagSettings()

If this IProperty is of the type Type#PROPERTY_FLAGS, this method will
tell you how many different flag settings it takes.

Returns:

Number of flag settings, or <0 if not a FLAGS value

getFlagConstant

public Property getFlagConstant(int position)

If this IProperty is of the type Type#PROPERTY_FLAGS, this method will
give you another IProperty representing a constant setting for that flag.

Parameters:

position - The position number for the flag; Must be in range 0 <= position <= #getNumFlagSettings().

Returns:

An IProperty object for the flag setting, or null if not available.

getFlagConstant

public Property getFlagConstant(String name)

If this IProperty is of the type Type#PROPERTY_FLAGS, this method will
give you another IProperty representing a constant setting for that flag.

Parameters:

name - The name of the constant.

Returns:

An IProperty object for the flag setting, or null if not available.