Package com.jogamp.opengl.util.av

Class SubtitleEvent

java.lang.Object

com.jogamp.opengl.util.av.SubtitleEvent

Direct Known Subclasses:

SubBitmapEvent, SubEmptyEvent, SubTextEvent

public abstract class SubtitleEvent
extends Object

Generic subtitle event

It is mandatory that the receiver release() this instance after processing, allowing the resource owner to free or reuse it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubtitleEvent.Type	SubtitleEvent Implementation Type

Field Summary

Fields

Modifier and Type	Field	Description
CodecID	codec	CodecID of this subtitle event.
String	lang	Language code, supposed to be 3-letters of `ISO 639-2 language codes`
int	pts_end	PTS end time in milliseconds to end showing this subtitle event.
int	pts_start	PTS start time in milliseconds to start showing this subtitle event.
SubtitleEvent.Type	type	Implementation SubtitleEvent.Type of this instance.

Constructor Summary

Constructors

Constructor	Description
SubtitleEvent(SubtitleEvent.Type type, CodecID codec, String lang, int pts_start, int pts_end)

Method Summary

Modifier and Type	Method	Description
int	getDuration()
String	getStartString()
boolean	isEndDefined()	See pts_end.
abstract void	release()	Release the resources, if any, back to the owner.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

public final SubtitleEvent.Type type

Implementation SubtitleEvent.Type of this instance.

codec

public final CodecID codec

CodecID of this subtitle event.

lang

public final String lang

Language code, supposed to be 3-letters of `ISO 639-2 language codes`

pts_start

public final int pts_start

PTS start time in milliseconds to start showing this subtitle event.

pts_end

public final int pts_end

PTS end time in milliseconds to end showing this subtitle event.

SubBitmapEvent often (e.g. CodecID.HDMV_PGS) have an infinite end-time, i.e. (Integer.MAX_VALUE, and shall be overwritten by the next one or SubEmptyEvent.

See Also:

isEndDefined()

Constructor Detail

SubtitleEvent

public SubtitleEvent(SubtitleEvent.Type type,
                     CodecID codec,
                     String lang,
                     int pts_start,
                     int pts_end)

Parameters:

type -

codec - the CodecID

lang - language code, supposed to be 3-letters of `ISO 639-2 language codes`

pts_start - pts start in ms, see pts_start

pts_end - pts end in ms, see pts_end

Method Detail

release

public abstract void release()

Release the resources, if any, back to the owner.

getDuration

public final int getDuration()

isEndDefined

public final boolean isEndDefined()

See pts_end.

getStartString

public final String getStartString()