org.mp4parser.boxes.iso14496.part30

Class WebVTTSampleEntry

java.lang.Object

org.mp4parser.BasicContainer

org.mp4parser.support.AbstractContainerBox

org.mp4parser.boxes.sampleentry.AbstractSampleEntry

org.mp4parser.boxes.iso14496.part30.WebVTTSampleEntry

All Implemented Interfaces:

Box, SampleEntry, Container, ParsableBox

public class WebVTTSampleEntry
extends AbstractSampleEntry

Sample Entry for WebVTT subtitles.

 class WVTTSampleEntry() extends PlainTextSampleEntry (‘wvtt’){
   WebVTTConfigurationBox config;
   WebVTTSourceLabelBox label; // recommended
   MPEG4BitRateBox (); // optional
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Fields inherited from class org.mp4parser.boxes.sampleentry.AbstractSampleEntry

dataReferenceIndex

Fields inherited from class org.mp4parser.support.AbstractContainerBox

largeBox, type

Constructor Summary

Constructors

Constructor and Description
WebVTTSampleEntry()

Method Summary

Modifier and Type	Method and Description
void	getBox(java.nio.channels.WritableByteChannel writableByteChannel) Writes the complete box - size | 4-cc | content - to the given writableByteChannel.
WebVTTConfigurationBox	getConfig()
WebVTTSourceLabelBox	getSourceLabel()
void	parse(java.nio.channels.ReadableByteChannel dataSource, java.nio.ByteBuffer header, long contentSize, BoxParser boxParser) Parses the box excluding the already parsed header (size, 4cc, [long-size], [user-type]).

Methods inherited from class org.mp4parser.boxes.sampleentry.AbstractSampleEntry

getDataReferenceIndex, setDataReferenceIndex

Methods inherited from class org.mp4parser.support.AbstractContainerBox

getHeader, getSize, getType, setParent

Methods inherited from class org.mp4parser.BasicContainer

addBox, getBoxes, getBoxes, getBoxes, getContainerSize, initContainer, setBoxes, toString, writeContainer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mp4parser.Box

getSize, getType

Methods inherited from interface org.mp4parser.Container

getBoxes, getBoxes, getBoxes, setBoxes, writeContainer

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

WebVTTSampleEntry

public WebVTTSampleEntry()

Method Detail

parse

public void parse(java.nio.channels.ReadableByteChannel dataSource,
                  java.nio.ByteBuffer header,
                  long contentSize,
                  BoxParser boxParser)
           throws java.io.IOException

Description copied from interface: ParsableBox

Parses the box excluding the already parsed header (size, 4cc, [long-size], [user-type]). The remaining size of the box is the contentSize, contentSize number of bytes should be read from the box source (readableByteChannel). If you need the header buffer at a later stage you have to create a copy.

Specified by:

parse in interface ParsableBox

Specified by:

parse in class AbstractSampleEntry

Parameters:

dataSource - the source for this box

header - the box' already parsed header (create copy if you need it later as it will be overwritten)

contentSize - remaining bytes of this box

boxParser - use it to parse sub-boxes.

Throws:

java.io.IOException - in case of an error during a read operation

getBox

public void getBox(java.nio.channels.WritableByteChannel writableByteChannel)
            throws java.io.IOException

Description copied from interface: Box

Writes the complete box - size | 4-cc | content - to the given writableByteChannel.

Specified by:

getBox in interface Box

Specified by:

getBox in class AbstractSampleEntry

Parameters:

writableByteChannel - the box's sink

Throws:

java.io.IOException - in case of problems with the Channel

getConfig

public WebVTTConfigurationBox getConfig()

getSourceLabel

public WebVTTSourceLabelBox getSourceLabel()