Package com.io7m.jspiel.api

Interface RiffFileWriterChunkDescriptionType

public interface RiffFileWriterChunkDescriptionType
A description of a RIFF chunk to be built.

  • Method Details

    • ordinal

      long ordinal()
      Retrieve the ordinal number of the chunk. The ordinal number is essentially a number that indicates in what order the chunk will appear in the output file. For any given chunk, the ordinal number is guaranteed to be greater than that of the parent chunk's ordinal, and is guaranteed to be greater than that of any previous sibling chunks. The ordinal number is also guaranteed to be unique within a file.
      Returns:
      The ordinal number of the chunk

    • file

      RiffFileWriterDescriptionType file()
      Returns:
      The file to which this chunk belongs

    • parent

      Optional<RiffFileWriterChunkDescriptionType> parent()
      Returns:
      The parent chunk of this chunk, if any

    • id

      RiffChunkID id()
      Returns:
      The ID of the chunk

    • declaredSize

      OptionalLong declaredSize()
      Returns:
      The declared size of the chunk, if any

    • subChunks

      List<RiffFileWriterChunkDescriptionType> subChunks()
      Returns:
      The list of subchunks of this chunk

    • form

      Optional<String> form()
      Returns:
      The chunk form, if any

    • dataWriter

      Optional<RiffChunkDataWriterType> dataWriter()
      Returns:
      The supplier of data for the chunk