Interface SubtitleStream

All Known Subinterfaces:
DvdSubtitleStream
All Known Implementing Classes:
SubDvd, SupBD, SupDvd, SupHD, SupXml

public interface SubtitleStream
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Close input stream.
    void
    decode(int index)
    Decode caption.
    Return the Bitmap of the current (last decoded) frame.
    long
    getEndTime(int index)
    Get end time stamp of given frame.
    int
    Get number of forced frames in the currently loaded subtitle stream.
    int
    Get number of frames in the currently loaded subtitle stream.
    Return current (last decoded) frame
    getImage(Bitmap bitmap)
    Return given Bitmap as BufferedImage (using current Palette).
    Return the Palette of the current (last decoded) frame.
    int
    Get index of most dominant opaque color (for DVD subtitle export).
    long
    getStartOffset(int index)
    Get start offset (in input stream) of given frame.
    long
    getStartTime(int index)
    Get start time stamp of given frame.
    getSubPicture(int index)
    Get SubPicture of given frame.
    boolean
    isForced(int index)
    Get forced flag of given frame.
  • Method Details

    • getPalette

      Palette getPalette()
      Return the Palette of the current (last decoded) frame.
      Returns:
      Palette of the current frame
    • getBitmap

      Bitmap getBitmap()
      Return the Bitmap of the current (last decoded) frame.
      Returns:
      Bitmap of the current frame
    • getImage

      BufferedImage getImage()
      Return current (last decoded) frame
      Returns:
      Current (last decoded) frame
    • getImage

      BufferedImage getImage(Bitmap bitmap)
      Return given Bitmap as BufferedImage (using current Palette).
      Parameters:
      bitmap - Bitmap to convert.
      Returns:
      BufferedImage of given bitmap
    • getPrimaryColorIndex

      int getPrimaryColorIndex()
      Get index of most dominant opaque color (for DVD subtitle export).
      Returns:
      Index of most dominant opaque color
    • decode

      void decode(int index) throws CoreException
      Decode caption.
      Parameters:
      index - Index of caption
      Throws:
      CoreException
    • getFrameCount

      int getFrameCount()
      Get number of frames in the currently loaded subtitle stream.
      Returns:
      Number of frames
    • getForcedFrameCount

      int getForcedFrameCount()
      Get number of forced frames in the currently loaded subtitle stream.
      Returns:
      Number of forced frames
    • isForced

      boolean isForced(int index)
      Get forced flag of given frame.
      Parameters:
      index - Index of caption
      Returns:
      Forced flag of given frame
    • close

      void close()
      Close input stream.
    • getEndTime

      long getEndTime(int index)
      Get end time stamp of given frame.
      Parameters:
      index - Index of caption
      Returns:
      End time stamp of given frame in 90kHz resolution
    • getStartTime

      long getStartTime(int index)
      Get start time stamp of given frame.
      Parameters:
      index - Index of caption
      Returns:
      Start time stamp of given frame in 90kHz resolution
    • getStartOffset

      long getStartOffset(int index)
      Get start offset (in input stream) of given frame.
      Parameters:
      index - Index of caption
      Returns:
      Start offset of given frame in input stream
    • getSubPicture

      SubPicture getSubPicture(int index)
      Get SubPicture of given frame.
      Parameters:
      index - Index of caption
      Returns:
      SubPicture of caption