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

Text Event Line including ASS/SAA of SubtitleEvent. More...

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

Classes

enum  ASSType
 ASS Formatting Type. More...
 
enum  TextFormat
 Text formatting. More...
 

Public Member Functions

 SubTextEvent (final CodecID codec, final String lang, final TextFormat fmt, final String ass, final int pts_start, final int pts_end)
 ASS/SAA Event Line ctor. More...
 
void release ()
 Release the resources, if any, back to the owner. More...
 
String toString ()
 
- Public Member Functions inherited from com.jogamp.opengl.util.av.SubtitleEvent
 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 TextFormat textFormat
 TextFormat of this text subtitle event. More...
 
final ASSType assType
 ASSType sub-type More...
 
final int start
 Start time in milliseconds, or -1. More...
 
final int end
 End time in milliseconds, or -1. More...
 
final String style
 
final int seqnr
 
final int layer
 
final String name
 
final String effect
 
final String text
 Actual subtitle text. More...
 
final int lines
 Number of lines of text, i.e. More...
 
- Public Attributes inherited from com.jogamp.opengl.util.av.SubtitleEvent
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

Text Event Line including ASS/SAA of SubtitleEvent.

See http://www.tcax.org/docs/ass-specs.htm

Definition at line 41 of file SubTextEvent.java.

Constructor & Destructor Documentation

◆ SubTextEvent()

com.jogamp.opengl.util.av.SubTextEvent.SubTextEvent ( final CodecID  codec,
final String  lang,
final TextFormat  fmt,
final String  ass,
final int  pts_start,
final int  pts_end 
)

ASS/SAA Event Line ctor.

Parameters
codecthe CodecID
langlanguage code, supposed to be 3-letters of ISO 639-2 language codes
fmtinput format of ass
assASS/SAA compatible event line according to ASSType
pts_startpts start in ms
pts_endpts end in ms

Definition at line 103 of file SubTextEvent.java.

Member Function Documentation

◆ release()

void com.jogamp.opengl.util.av.SubTextEvent.release ( )

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

Reimplemented from com.jogamp.opengl.util.av.SubtitleEvent.

Definition at line 223 of file SubTextEvent.java.

◆ toString()

String com.jogamp.opengl.util.av.SubTextEvent.toString ( )

Definition at line 226 of file SubTextEvent.java.

Here is the call graph for this function:

Member Data Documentation

◆ assType

final ASSType com.jogamp.opengl.util.av.SubTextEvent.assType

ASSType sub-type

Definition at line 75 of file SubTextEvent.java.

◆ effect

final String com.jogamp.opengl.util.av.SubTextEvent.effect

Definition at line 86 of file SubTextEvent.java.

◆ end

final int com.jogamp.opengl.util.av.SubTextEvent.end

End time in milliseconds, or -1.

Definition at line 79 of file SubTextEvent.java.

◆ layer

final int com.jogamp.opengl.util.av.SubTextEvent.layer

Definition at line 83 of file SubTextEvent.java.

◆ lines

final int com.jogamp.opengl.util.av.SubTextEvent.lines

Number of lines of text, i.e.

occurrence of \n + 1.

Definition at line 90 of file SubTextEvent.java.

◆ name

final String com.jogamp.opengl.util.av.SubTextEvent.name

Definition at line 85 of file SubTextEvent.java.

◆ seqnr

final int com.jogamp.opengl.util.av.SubTextEvent.seqnr

Definition at line 82 of file SubTextEvent.java.

◆ start

final int com.jogamp.opengl.util.av.SubTextEvent.start

Start time in milliseconds, or -1.

Definition at line 77 of file SubTextEvent.java.

◆ style

final String com.jogamp.opengl.util.av.SubTextEvent.style

Definition at line 80 of file SubTextEvent.java.

◆ text

final String com.jogamp.opengl.util.av.SubTextEvent.text

Actual subtitle text.

Definition at line 88 of file SubTextEvent.java.

◆ textFormat

final TextFormat com.jogamp.opengl.util.av.SubTextEvent.textFormat

TextFormat of this text subtitle event.

Definition at line 73 of file SubTextEvent.java.


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