io.humble.video

Class Filter

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Configurable

io.humble.video.Filter

Direct Known Subclasses:

FilterEndPoint

public class Filter
extends Configurable

A Filter that can convert one MediaRaw object into zero or more other
MediaRaw objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Filter.CommandFlag Flags that can be passed when processing commands.

Method Summary

Modifier and Type	Method and Description
Filter	copyReference() Create a new Filter 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.
FilterGraph	getGraph()
FilterLink	getInputLink(int index)
String	getInputName(int index)
MediaDescriptor.Type	getInputType(int index)
String	getName()
int	getNumInputs()
int	getNumOutputs()
FilterLink	getOutputLink(int index)
String	getOutputName(int index)
MediaDescriptor.Type	getOutputType(int index)
int	hashCode() Get a hashable value for this object.

Methods inherited from class io.humble.video.Configurable

getNumProperties, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsInt, getPropertyAsLong, getPropertyAsRational, getPropertyAsString, getPropertyMetaData, getPropertyMetaData, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty

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

Create a new Filter object that is actually referring to the exact same underlying native object.

Overrides:

copyReference in class Configurable

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 Configurable

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 Configurable

Returns:

the hashable value.

getName

public String getName()

Returns:

name of filter.

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().

getInputLink

public FilterLink getInputLink(int index)

Parameters:

index - which input to get link of

Returns:

the FilterLink that is inputting into this filter at the given position.

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().

getOutputLink

public FilterLink getOutputLink(int index)

Parameters:

index - which output to get link of

Returns:

the FilterLink that is outputting from this filter at the given position.

Throws:

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

getGraph

public FilterGraph getGraph()

Returns:

the graph this filter is part of.