Module com.io7m.jspiel.api
Package com.io7m.jspiel.api

Interface RiffChunkType

  • public interface RiffChunkType
    A parsed RIFF chunk. Values of this type are effectively immutable.

    • Method Detail

      • parent

        java.util.Optional<RiffChunkType> parent()
        Returns:
        The parent of this RIFF chunk, if one exists

      • offset

        long offset()
        Returns:
        The absolute offset in octets of the start of this chunk within the RIFF file

      • dataSizeIncludingForm

        RiffSize dataSizeIncludingForm()
        Returns:
        The size in octets of the data in this chunk, including any form field (if present)

      • totalSize

        default long totalSize()
        Returns:
        The total size of this chunk, including the data (and padding), chunk ID, and chunk size field

      • formType

        java.util.Optional<java.lang.String> formType()
        Returns:
        The form type of this chunk (only applicable to RIFF and LIST chunks).

      • subChunks

        java.util.List<RiffChunkType> subChunks()
        Returns:
        A read-only list of subchunks within this chunk (only applicable to RIFF and LIST chunks).

      • dataOffset

        default long dataOffset()
        Returns:
        The absolute offset in octets of the start of this chunk's data within the RIFF file

      • linearizedDescendantChunks

        default java.util.stream.Stream<RiffChunkType> linearizedDescendantChunks()
        Returns:
        The linearized subchunks, including all descendants, in depth-first order

      • dataSizeExcludingForm

        default RiffSize dataSizeExcludingForm()
        Returns:
        The size in octets of the data in this chunk, excluding any form field (if present)