io.humble.video

Class FilterType

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.FilterType

public class FilterType
extends RefCounted

A type of filter that can be created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterType.Flag Flags that show features different FilterType object support.

Method Summary

Modifier and Type	Method and Description
FilterType	copyReference() Create a new FilterType 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.
static FilterType	findFilterType(String name) Find a given filter by name.
String	getDescription()
static FilterType	getFilterType(int index)
boolean	getFlag(FilterType.Flag flag)
int	getFlags()
String	getInputName(int index)
MediaDescriptor.Type	getInputType(int index)
String	getName()
static int	getNumFilterTypes()
int	getNumInputs()
int	getNumOutputs()
String	getOutputName(int index)
MediaDescriptor.Type	getOutputType(int index)
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 FilterType copyReference()

Create a new FilterType 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()

Returns:

name of this filter type.

getDescription

public String getDescription()

Returns:

description of this filter type.

getFlags

public int getFlags()

Returns:

bitmask of Flags set on this FilterType.

getFlag

public boolean getFlag(FilterType.Flag flag)

Parameters:

flag - flag to check setting of.

Returns:

is this flag set on the given FilterType

getNumInputs

public int getNumInputs()

Returns:

number of inputs this FilterType expects.

getInputName

public String getInputName(int index)

Parameters:

index - which input to get name of

Returns:

the input name

Throws:

InvalidArgument - if index < 0 || index > #getNumInputs().

getInputType

public MediaDescriptor.Type getInputType(int index)

Parameters:

index - which input to get type of

Returns:

the input media type

Throws:

InvalidArgument - if index < 0 || index > #getNumInputs().

getNumOutputs

public int getNumOutputs()

Returns:

number of outputs this FilterType expects.

getOutputName

public String getOutputName(int index)

Parameters:

index - which output to get name of

Returns:

the output name

Throws:

InvalidArgument - if index < 0 || index > #getNumOutputs().

getOutputType

public MediaDescriptor.Type getOutputType(int index)

Parameters:

index - which output to get type of

Returns:

the output media type

Throws:

InvalidArgument - if index < 0 || index > #getNumOutputs().

findFilterType

public static FilterType findFilterType(String name)

Find a given filter by name.

Parameters:

name - name of filter.

getNumFilterTypes

public static int getNumFilterTypes()

Returns:

the number of filters installed in this system.

getFilterType

public static FilterType getFilterType(int index)

Parameters:

index - the position in the list of installed filters to get. Use
with #getNumFilters() to iterate over all the filters installed
in the system.

Returns:

get the filter at the index position in the installed filters.

Throws:

InvalidArgument - if index < 0 || index >= #getNumFilterTypes().