JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.util.av.SubtitleEvent Class Referenceabstract

Generic subtitle event. More...

Inheritance diagram for com.jogamp.opengl.util.av.SubtitleEvent:
Collaboration diagram for com.jogamp.opengl.util.av.SubtitleEvent:

Classes

enum  Type
 SubtitleEvent Implementation Type More...
 

Public Member Functions

 SubtitleEvent (final Type type, final CodecID codec, final String lang, final int pts_start, final int pts_end)
 
abstract void release ()
 Release the resources, if any, back to the owner. More...
 
final int getDuration ()
 
final boolean isEndDefined ()
 See pts_end. More...
 
final String getStartString ()
 

Public Attributes

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

Detailed Description

Generic subtitle event.

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

Definition at line 12 of file SubtitleEvent.java.

Constructor & Destructor Documentation

◆ SubtitleEvent()

com.jogamp.opengl.util.av.SubtitleEvent.SubtitleEvent ( final Type  type,
final CodecID  codec,
final String  lang,
final int  pts_start,
final int  pts_end 
)
Parameters
type
codecthe CodecID
langlanguage code, supposed to be 3-letters of ISO 639-2 language codes
pts_startpts start in ms, see pts_start
pts_endpts end in ms, see pts_end

Definition at line 48 of file SubtitleEvent.java.

Member Function Documentation

◆ getDuration()

final int com.jogamp.opengl.util.av.SubtitleEvent.getDuration ( )

Definition at line 59 of file SubtitleEvent.java.

Here is the caller graph for this function:

◆ getStartString()

final String com.jogamp.opengl.util.av.SubtitleEvent.getStartString ( )

Definition at line 64 of file SubtitleEvent.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isEndDefined()

final boolean com.jogamp.opengl.util.av.SubtitleEvent.isEndDefined ( )

See pts_end.

Definition at line 62 of file SubtitleEvent.java.

Here is the caller graph for this function:

◆ release()

abstract void com.jogamp.opengl.util.av.SubtitleEvent.release ( )
abstract

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

Reimplemented in com.jogamp.opengl.util.av.SubBitmapEvent, com.jogamp.opengl.util.av.SubEmptyEvent, and com.jogamp.opengl.util.av.SubTextEvent.

Member Data Documentation

◆ codec

final CodecID com.jogamp.opengl.util.av.SubtitleEvent.codec

CodecID of this subtitle event.

Definition at line 25 of file SubtitleEvent.java.

◆ lang

final String com.jogamp.opengl.util.av.SubtitleEvent.lang

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

Definition at line 27 of file SubtitleEvent.java.

◆ pts_end

final int com.jogamp.opengl.util.av.SubtitleEvent.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()

Definition at line 38 of file SubtitleEvent.java.

◆ pts_start

final int com.jogamp.opengl.util.av.SubtitleEvent.pts_start

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

Definition at line 29 of file SubtitleEvent.java.

◆ type

final Type com.jogamp.opengl.util.av.SubtitleEvent.type

Implementation Type of this instance.

Definition at line 23 of file SubtitleEvent.java.


The documentation for this class was generated from the following file: