QuicktimeTextSampleEntry (ISO Parser 1.9.41.4 API)

java.lang.Object
- org.mp4parser.BasicContainer
- - org.mp4parser.support.AbstractContainerBox
  - - org.mp4parser.boxes.sampleentry.AbstractSampleEntry
    - - org.mp4parser.boxes.apple.QuicktimeTextSampleEntry

All Implemented Interfaces:

Box, SampleEntry, Container, ParsableBox
```
public class QuicktimeTextSampleEntry
extends AbstractSampleEntry
```
4cc = ""text""
Entry type for timed text samples defined in the timed text specification (ISO/IEC 14496-17).

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String TYPE
- Fields inherited from class org.mp4parser.support.AbstractContainerBox
  largeBox, type

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

Constructor Summary

Constructors
Constructor and Description

QuicktimeTextSampleEntry()

Constructors
Constructor and Description
`QuicktimeTextSampleEntry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBox(Box box)` Add `box` to the container and sets the parent correctly.
`int`	`getBackgroundB()`
`int`	`getBackgroundG()`
`int`	`getBackgroundR()`
`void`	`getBox(java.nio.channels.WritableByteChannel writableByteChannel)` Writes the complete box - size \| 4-cc \| content - to the given `writableByteChannel`.
`long`	`getDefaultTextBox()`
`int`	`getDisplayFlags()`
`short`	`getFontFace()`
`java.lang.String`	`getFontName()`
`short`	`getFontNumber()`
`int`	`getForegroundB()`
`int`	`getForegroundG()`
`int`	`getForegroundR()`
`long`	`getReserved1()`
`byte`	`getReserved2()`
`short`	`getReserved3()`
`long`	`getSize()`
`int`	`getTextJustification()`
`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]).
`void`	`setBackgroundB(int backgroundB)`
`void`	`setBackgroundG(int backgroundG)`
`void`	`setBackgroundR(int backgroundR)`
`void`	`setBoxes(java.util.List<? extends Box> boxes)` Sets all boxes and removes all previous child boxes.
`void`	`setDefaultTextBox(long defaultTextBox)`
`void`	`setDisplayFlags(int displayFlags)`
`void`	`setFontFace(short fontFace)`
`void`	`setFontName(java.lang.String fontName)`
`void`	`setFontNumber(short fontNumber)`
`void`	`setForegroundB(int foregroundB)`
`void`	`setForegroundG(int foregroundG)`
`void`	`setForegroundR(int foregroundR)`
`void`	`setReserved1(long reserved1)`
`void`	`setReserved2(byte reserved2)`
`void`	`setReserved3(short reserved3)`
`void`	`setTextJustification(int textJustification)`

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

Methods inherited from interface org.mp4parser.Container
getBoxes, getBoxes, getBoxes, writeContainer

- Field Detail
  - TYPE
```
public static final java.lang.String TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - QuicktimeTextSampleEntry
```
public QuicktimeTextSampleEntry()
```
- 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
  - setBoxes
```
public void setBoxes(java.util.List<? extends Box> boxes)
```
    Description copied from interface: Container
    
    Sets all boxes and removes all previous child boxes.
    
    Specified by:
    
    setBoxes in interface Container
    
    Overrides:
    
    setBoxes in class BasicContainer
    
    Parameters:
    
    boxes - the new list of children
  - addBox
```
public void addBox(Box box)
```
    Description copied from class: BasicContainer
    
    Add box to the container and sets the parent correctly. If box is null nochange will be performed and no error thrown.
    
    Overrides:
    
    addBox in class BasicContainer
    
    Parameters:
    
    box - will be added to the container
  - 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
  - getSize
```
public long getSize()
```
    Specified by:
    
    getSize in interface Box
    
    Overrides:
    
    getSize in class AbstractContainerBox
  - getDisplayFlags
```
public int getDisplayFlags()
```
  - setDisplayFlags
```
public void setDisplayFlags(int displayFlags)
```
  - getTextJustification
```
public int getTextJustification()
```
  - setTextJustification
```
public void setTextJustification(int textJustification)
```
  - getBackgroundR
```
public int getBackgroundR()
```
  - setBackgroundR
```
public void setBackgroundR(int backgroundR)
```
  - getBackgroundG
```
public int getBackgroundG()
```
  - setBackgroundG
```
public void setBackgroundG(int backgroundG)
```
  - getBackgroundB
```
public int getBackgroundB()
```
  - setBackgroundB
```
public void setBackgroundB(int backgroundB)
```
  - getDefaultTextBox
```
public long getDefaultTextBox()
```
  - setDefaultTextBox
```
public void setDefaultTextBox(long defaultTextBox)
```
  - getReserved1
```
public long getReserved1()
```
  - setReserved1
```
public void setReserved1(long reserved1)
```
  - getFontNumber
```
public short getFontNumber()
```
  - setFontNumber
```
public void setFontNumber(short fontNumber)
```
  - getFontFace
```
public short getFontFace()
```
  - setFontFace
```
public void setFontFace(short fontFace)
```
  - getReserved2
```
public byte getReserved2()
```
  - setReserved2
```
public void setReserved2(byte reserved2)
```
  - getReserved3
```
public short getReserved3()
```
  - setReserved3
```
public void setReserved3(short reserved3)
```
  - getForegroundR
```
public int getForegroundR()
```
  - setForegroundR
```
public void setForegroundR(int foregroundR)
```
  - getForegroundG
```
public int getForegroundG()
```
  - setForegroundG
```
public void setForegroundG(int foregroundG)
```
  - getForegroundB
```
public int getForegroundB()
```
  - setForegroundB
```
public void setForegroundB(int foregroundB)
```
  - getFontName
```
public java.lang.String getFontName()
```
  - setFontName
```
public void setFontName(java.lang.String fontName)
```

Class QuicktimeTextSampleEntry

4cc = ""text""

Field Summary

Fields inherited from class org.mp4parser.support.AbstractContainerBox

Constructor Summary

Method Summary

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

Methods inherited from class org.mp4parser.support.AbstractContainerBox

Methods inherited from class org.mp4parser.BasicContainer

Methods inherited from class java.lang.Object

Methods inherited from interface org.mp4parser.Box

Methods inherited from interface org.mp4parser.Container

Field Detail

TYPE

Constructor Detail

QuicktimeTextSampleEntry

Method Detail

parse

setBoxes

addBox

getBox

getSize

getDisplayFlags

setDisplayFlags

getTextJustification

setTextJustification

getBackgroundR

setBackgroundR

getBackgroundG

setBackgroundG

getBackgroundB

setBackgroundB

getDefaultTextBox

setDefaultTextBox

getReserved1

setReserved1

getFontNumber

setFontNumber

getFontFace

setFontFace

getReserved2

setReserved2

getReserved3

setReserved3

getForegroundR

setForegroundR

getForegroundG

setForegroundG

getForegroundB

setForegroundB

getFontName

setFontName