io.humble.video

Class MediaResampler

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Configurable

io.humble.video.MediaResampler

Direct Known Subclasses:

MediaAudioResampler, MediaPictureResampler

public class MediaResampler
extends Configurable

Super class for Media Resampler objects.

A resampler converts a type of media (e.g. Picture) to another
type of the same media with some parameters change (e.g. color).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaResampler.State

Method Summary

Modifier and Type	Method and Description
MediaResampler	copyReference() Create a new MediaResampler 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.
MediaResampler.State	getState()
int	hashCode() Get a hashable value for this object.
int	resample(MediaSampled out, MediaSampled in) Resample in to out based on the resampler parameters. Resamples the in media based on the parameters set when this resampler was constructed.

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

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

getState

public MediaResampler.State getState()

resample

public int resample(MediaSampled out,
                    MediaSampled in)

Resample in to out based on the resampler parameters.

Resamples the in media based on the parameters set when
this resampler was constructed.

Parameters:

out - The media we'll resample to. Check
MediaSampled#isComplete() after the call.

in - The media we'll resample from.

Throws:

InvalidArgument - if in our out does not match the parameters this
resampler was set with.

InvalidArgument - if the sub-class of in our out is of an invalid
type (e.g. passsing audio to a picture resampler).