io.humble.video

Class MediaSubtitle

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.Media

io.humble.video.MediaRaw

io.humble.video.MediaSubtitle

public class MediaSubtitle
extends MediaRaw

NOT CURRENTLY USED.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaSubtitle.Type

Field Summary

Fields inherited from class io.humble.video.Media

DEFAULT_TIME_STAMP_FORMAT

Method Summary

Modifier and Type	Method and Description
MediaSubtitle	copyReference() Create a new MediaSubtitle 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	getBestEffortTimeStamp() frame timestamp estimated using various heuristics, in stream time base - encoding: unused - decoding: set by libavcodec, read by user.
long	getEndDisplayTime() Get the end display time in ms, relative to #getTimeStamp().
int	getFormat()
int	getNumRectangles() Get the number of rectangles this subtitle draws
long	getPacketDts() dts copied from the Packet that triggered returning this frame - encoding: unused - decoding: Read by user.
long	getPacketDuration() duration of the corresponding packet, expressed in ContainerStream.getTimeBase() units, 0 if unknown. - encoding: unused - decoding: Read by user.
long	getPacketPts() pts copied from the Packet that was decoded to produce this frame - encoding: unused - decoding: Read by user.
int	getPacketSize() size of the corresponding packet containing the compressed frame. It is set to a negative value if unknown. - encoding: unused - decoding: set by libavcodec, read by user.
long	getPts() Get the presentation time stamp
MediaSubtitleRectangle	getRectangle(int n)
long	getStartDisplayTime() Get the start display time in ms, relative to the #getTimeStamp().
long	getTimeStamp() Get the presentation timestamp of this subtitle
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	setComplete(boolean complete)
void	setComplete(boolean complete, long timestamp) Sets the subtitle to be complete.
void	setTimeStamp(long timeStamp) Set the time stamp for this object in getTimeBase() units.

Methods inherited from class io.humble.video.MediaRaw

getMetaData, getTimeBase, setTimeBase

Methods inherited from class io.humble.video.Media

getFormattedTimeStamp, getFormattedTimeStamp

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

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

Overrides:

copyReference in class MediaRaw

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 MediaRaw

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 MediaRaw

Returns:

the hashable value.

getFormat

public int getFormat()

getStartDisplayTime

public long getStartDisplayTime()

Get the start display time in ms, relative to the #getTimeStamp().

getEndDisplayTime

public long getEndDisplayTime()

Get the end display time in ms, relative to #getTimeStamp().

getNumRectangles

public int getNumRectangles()

Get the number of rectangles this subtitle draws

getTimeStamp

public long getTimeStamp()

Get the presentation timestamp of this subtitle

Overrides:

getTimeStamp in class MediaRaw

Returns:

the time stamp

getRectangle

public MediaSubtitleRectangle getRectangle(int n)

setTimeStamp

public void setTimeStamp(long timeStamp)

Description copied from class: MediaRaw

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

Overrides:

setTimeStamp in class MediaRaw

Parameters:

timeStamp - The time stamp

isKey

public boolean isKey()

Description copied from class: MediaRaw

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

Overrides:

isKey in class MediaRaw

Returns:

true if it's a key, false if not

getPts

public long getPts()

Description copied from class: MediaRaw

Get the presentation time stamp

Overrides:

getPts in class MediaRaw

getPacketPts

public long getPacketPts()

Description copied from class: MediaRaw

pts copied from the Packet that was decoded to produce this frame
- encoding: unused
- decoding: Read by user.

Overrides:

getPacketPts in class MediaRaw

getPacketDts

public long getPacketDts()

Description copied from class: MediaRaw

dts copied from the Packet that triggered returning this frame
- encoding: unused
- decoding: Read by user.

Overrides:

getPacketDts in class MediaRaw

getPacketSize

public int getPacketSize()

Description copied from class: MediaRaw

size of the corresponding packet containing the compressed
frame.
It is set to a negative value if unknown.
- encoding: unused
- decoding: set by libavcodec, read by user.

Overrides:

getPacketSize in class MediaRaw

getPacketDuration

public long getPacketDuration()

Description copied from class: MediaRaw

duration of the corresponding packet, expressed in
ContainerStream.getTimeBase() units, 0 if unknown.
- encoding: unused
- decoding: Read by user.

Overrides:

getPacketDuration in class MediaRaw

getBestEffortTimeStamp

public long getBestEffortTimeStamp()

Description copied from class: MediaRaw

frame timestamp estimated using various heuristics, in stream time base
- encoding: unused
- decoding: set by libavcodec, read by user.

Overrides:

getBestEffortTimeStamp in class MediaRaw

isComplete

public boolean isComplete()

Description copied from class: Media

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

Overrides:

isComplete in class Media

Returns:

Has setComplete() been called and the buffer populated.

setComplete

public void setComplete(boolean complete,
                        long timestamp)

Sets the subtitle to be complete.

setComplete

public void setComplete(boolean complete)

Overrides:

setComplete in class MediaRaw

Parameters:

complete - is the object complete or not.

See Also:

Media.isComplete()