Package org.mp4parser.boxes.sampleentry

Class TextSampleEntry

java.lang.Object

org.mp4parser.BasicContainer

org.mp4parser.support.AbstractContainerBox

org.mp4parser.boxes.sampleentry.AbstractSampleEntry

org.mp4parser.boxes.sampleentry.TextSampleEntry

All Implemented Interfaces:

Box, SampleEntry, Container, ParsableBox

public class TextSampleEntry
extends AbstractSampleEntry

4cc = ""tx3g""

Entry type for timed text samples defined in the timed text specification (ISO/IEC 14496-17).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextSampleEntry.BoxRecord
static class	TextSampleEntry.StyleRecord

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE_ENCRYPTED
static String	TYPE1

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

dataReferenceIndex

Fields inherited from class org.mp4parser.support.AbstractContainerBox

largeBox, type

Constructor Summary

Constructors

Constructor	Description
TextSampleEntry()
TextSampleEntry(String type)

Method Summary

Modifier and Type	Method	Description
int[]	getBackgroundColorRgba()
void	getBox(WritableByteChannel writableByteChannel)	Writes the complete box - size | 4-cc | content - to the given writableByteChannel.
TextSampleEntry.BoxRecord	getBoxRecord()
int	getHorizontalJustification()
long	getSize()
TextSampleEntry.StyleRecord	getStyleRecord()
int	getVerticalJustification()
boolean	isContinuousKaraoke()
boolean	isFillTextRegion()
boolean	isScrollDirection()
boolean	isScrollIn()
boolean	isScrollOut()
boolean	isWriteTextVertically()
void	parse(ReadableByteChannel dataSource, ByteBuffer header, long contentSize, BoxParser boxParser)	Parses the box excluding the already parsed header (size, 4cc, [long-size], [user-type]).
void	setBackgroundColorRgba(int[] backgroundColorRgba)
void	setBoxRecord(TextSampleEntry.BoxRecord boxRecord)
void	setContinuousKaraoke(boolean continuousKaraoke)
void	setFillTextRegion(boolean fillTextRegion)
void	setHorizontalJustification(int horizontalJustification)
void	setScrollDirection(boolean scrollOutIn)
void	setScrollIn(boolean scrollIn)
void	setScrollOut(boolean scrollOutIn)
void	setStyleRecord(TextSampleEntry.StyleRecord styleRecord)
void	setType(String type)
void	setVerticalJustification(int verticalJustification)
void	setWriteTextVertically(boolean writeTextVertically)
String	toString()

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

getDataReferenceIndex, setDataReferenceIndex

Methods inherited from class org.mp4parser.support.AbstractContainerBox

getHeader, getType, setParent

Methods inherited from class org.mp4parser.BasicContainer

addBox, getBoxes, getBoxes, getBoxes, getContainerSize, initContainer, setBoxes, 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

getType

Methods inherited from interface org.mp4parser.Container

getBoxes, getBoxes, getBoxes, setBoxes, writeContainer

Field Detail

TYPE1

public static final String TYPE1

See Also:

Constant Field Values

TYPE_ENCRYPTED

public static final String TYPE_ENCRYPTED

See Also:

Constant Field Values

Constructor Detail

TextSampleEntry

public TextSampleEntry()

TextSampleEntry

public TextSampleEntry(String type)

Method Detail

setType

public void setType(String type)

parse

public void parse(ReadableByteChannel dataSource,
                  ByteBuffer header,
                  long contentSize,
                  BoxParser boxParser)
           throws 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:

IOException - in case of an error during a read operation

getBox

public void getBox(WritableByteChannel writableByteChannel)
            throws 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:

IOException - in case of problems with the Channel

toString

public String toString()

Overrides:

toString in class BasicContainer

getBoxRecord

public TextSampleEntry.BoxRecord getBoxRecord()

setBoxRecord

public void setBoxRecord(TextSampleEntry.BoxRecord boxRecord)

getStyleRecord

public TextSampleEntry.StyleRecord getStyleRecord()

setStyleRecord

public void setStyleRecord(TextSampleEntry.StyleRecord styleRecord)

isScrollIn

public boolean isScrollIn()

setScrollIn

public void setScrollIn(boolean scrollIn)

isScrollOut

public boolean isScrollOut()

setScrollOut

public void setScrollOut(boolean scrollOutIn)

isScrollDirection

public boolean isScrollDirection()

setScrollDirection

public void setScrollDirection(boolean scrollOutIn)

isContinuousKaraoke

public boolean isContinuousKaraoke()

setContinuousKaraoke

public void setContinuousKaraoke(boolean continuousKaraoke)

isWriteTextVertically

public boolean isWriteTextVertically()

setWriteTextVertically

public void setWriteTextVertically(boolean writeTextVertically)

isFillTextRegion

public boolean isFillTextRegion()

setFillTextRegion

public void setFillTextRegion(boolean fillTextRegion)

getHorizontalJustification

public int getHorizontalJustification()

setHorizontalJustification

public void setHorizontalJustification(int horizontalJustification)

getVerticalJustification

public int getVerticalJustification()

setVerticalJustification

public void setVerticalJustification(int verticalJustification)

getBackgroundColorRgba

public int[] getBackgroundColorRgba()

setBackgroundColorRgba

public void setBackgroundColorRgba(int[] backgroundColorRgba)

getSize

public long getSize()

Specified by:

getSize in interface Box

Overrides:

getSize in class AbstractContainerBox