io.humble.video

Class Media

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Media

Direct Known Subclasses:

MediaEncoded, MediaRaw

public class Media
extends RefCounted

The parent class of all media objects than can be gotten from or added to a Stream.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TIME_STAMP_FORMAT The default time stamp format.

Method Summary

Modifier and Type	Method and Description
Media	copyReference() Create a new Media 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.
String	getFormattedTimeStamp() Get a string representation of the time stamp for this Media.
String	getFormattedTimeStamp(String format) Get a string representation of the time stamp for this Media.
Rational	getTimeBase() Get the time base that time stamps of this object are represented in. Caller must release the returned value.
long	getTimeStamp() Get the time stamp of this object in getTimeBase() units.
int	hashCode() Get a hashable value for this object.
boolean	isComplete() Returns whether or not we think this buffer has been filled with data.
boolean	isKey() Is this object a key object? i.e.
void	setTimeStamp(long aTimeStamp) Set the time stamp for this object in getTimeBase() units.

Methods inherited from class io.humble.ferry.RefCounted

delete, getCurrentRefCount

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_TIME_STAMP_FORMAT

public static final String DEFAULT_TIME_STAMP_FORMAT

The default time stamp format.

See Also:

Constant Field Values

Method Detail

copyReference

public Media copyReference()

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

getFormattedTimeStamp

public String getFormattedTimeStamp()

Get a string representation of the time stamp for this Media. The time is formatted as: HH:MM:SS.ms

Returns:

the printable string form of the time stamp of this media

See Also:

getFormattedTimeStamp(String), DEFAULT_TIME_STAMP_FORMAT

getFormattedTimeStamp

public String getFormattedTimeStamp(String format)

Get a string representation of the time stamp for this Media. The format of the resulting string is specified by the format parameter. See Formatter for details on how to specify formats, however a good place to start is with the following format: %1$tH:%1$tM:%1$tS.%1$tL

Parameters:

format - the format for the time stamp string

Returns:

the printable string form of the timestamp

See Also:

getFormattedTimeStamp(), DEFAULT_TIME_STAMP_FORMAT, Formatter

getTimeStamp

public long getTimeStamp()

Get the time stamp of this object in getTimeBase() units.

Returns:

the time stamp

setTimeStamp

public void setTimeStamp(long aTimeStamp)

Set the time stamp for this object in getTimeBase() units.

Parameters:

aTimeStamp - The time stamp

getTimeBase

public Rational getTimeBase()

Get the time base that time stamps of this object are represented in.

Caller must release the returned value.

Returns:

the time base.

isKey

public boolean isKey()

Is this object a key object? i.e. it can be interpreted without needing any other media objects

Returns:

true if it's a key, false if not

isComplete

public boolean isComplete()

Returns whether or not we think this buffer has been filled
with data.

Returns:

Has setComplete() been called and the buffer populated.