com.coremedia.iso.boxes

Interface Box

All Known Subinterfaces:

FullBox, SampleEntry

All Known Implementing Classes:

AbstractBox, AbstractContainerBox, AbstractCueBox, AbstractDescriptorBox, AbstractFullBox, AbstractMediaHeaderBox, AbstractSampleEncryptionBox, AbstractSampleEntry, AbstractTrackEncryptionBox, AC3SpecificBox, ActionMessageFormat0SampleEntryBox, AlbumArtistBox, AlbumBox, AmrSpecificBox, Apple_atIDBox, Apple_flvr_Box, Apple_geIDBox, Apple_xid_Box, AppleAlbumBox, AppleAppleIdBox, AppleArtist2Box, AppleArtistBox, AppleCommentBox, AppleCompilationBox, AppleCopyrightBox, AppleCountryTypeBoxBox, AppleCoverBox, AppleDataBox, AppleDataRateBox, AppleDataReferenceBox, AppleDescriptionBox, AppleDiskNumberBox, AppleEncoderBox, AppleGaplessPlaybackBox, AppleGenreBox, AppleGenreIDBox, AppleGPSCoordinatesBox, AppleGroupingBox, AppleItemListBox, AppleLongDescriptionBox, AppleLosslessSpecificBox, AppleLyricsBox, AppleMediaTypeBox, AppleNameBox, ApplePurchaseDateBox, AppleRecordingYear2Box, AppleRecordingYearBox, AppleReferenceMovieBox, AppleReferenceMovieDescriptorBox, AppleShortDescriptionBox, AppleSortAlbumBox, AppleTempoBox, AppleTrackAuthorBox, AppleTrackNumberBox, AppleTVEpisodeBox, AppleTVEpisodeNumberBox, AppleTVNetworkBox, AppleTVSeasonBox, AppleTVShowBox, AppleVariableSignedIntegerBox, AppleWaveBox, AssetInformationBox, AudioSampleEntry, AuthorBox, AvcConfigurationBox, AvcNalUnitStorageBox, BaseLocationBox, BaseMediaInfoAtom, BitRateBox, ChunkOffset64BitBox, ChunkOffsetBox, ClassificationBox, CleanApertureAtom, CompositionShiftLeastGreatestAtom, CompositionTimeToSample, ContentDistributorIdBox, ContentInformationBox, CopyrightBox, CoverUriBox, CueIDBox, CuePayloadBox, CueSettingsBox, CueSourceIDBox, CueTimeBox, DataEntryUrlBox, DataEntryUrnBox, DataInformationBox, DataReferenceBox, DescriptionBox, DTSSpecificBox, EC3SpecificBox, EditBox, EditListBox, ESDescriptorBox, EventMessageBox, FileTypeBox, FontTableBox, FreeBox, FreeSpaceBox, FullContainerBox, GenericMediaHeaderAtom, GenericMediaHeaderTextAtom, GenreBox, HandlerBox, HevcConfigurationBox, HintMediaHeaderBox, HintSampleEntry, ItemDataBox, ItemLocationBox, ItemProtectionBox, KeywordsBox, LocationInformationBox, LyricsUriBox, MediaBox, MediaDataBox, MediaHeaderBox, MediaInformationBox, MetaBox, MLPSpecificBox, MovieBox, MovieExtendsBox, MovieExtendsHeaderBox, MovieFragmentBox, MovieFragmentHeaderBox, MovieFragmentRandomAccessBox, MovieFragmentRandomAccessOffsetBox, MovieHeaderBox, MpegSampleEntry, NullMediaHeaderBox, ObjectDescriptorBox, OmaDrmAccessUnitFormatBox, OriginalFormatBox, Ovc1VisualSampleEntryImpl, PerformerBox, PiffSampleEncryptionBox, PiffTrackEncryptionBox, PixelAspectRationAtom, PriotityRangeBox, ProgressiveDownloadInformationBox, ProtectionSchemeInformationBox, ProtectionSystemSpecificHeaderBox, QuicktimeTextSampleEntry, RatingBox, RecordingYearBox, SampleAuxiliaryInformationOffsetsBox, SampleAuxiliaryInformationSizesBox, SampleDependencyTypeBox, SampleDescriptionBox, SampleEncryptionBox, SampleGroupDescriptionBox, SampleSizeBox, SampleTableBox, SampleToChunkBox, SampleToGroupBox, SchemeInformationBox, SchemeTypeBox, SegmentIndexBox, SegmentTypeBox, SoundMediaHeaderBox, StaticChunkOffsetBox, SubSampleInformationBox, SubtitleMediaHeaderBox, SyncSampleBox, TextSampleEntry, TfrfBox, TfxdBox, TierBitRateBox, TierInfoBox, TimeCodeBox, TimeToSampleBox, TitleBox, TrackApertureModeDimensionAtom, TrackBox, TrackEncodedPixelsDimensionsAtom, TrackEncryptionBox, TrackExtendsBox, TrackFragmentBaseMediaDecodeTimeBox, TrackFragmentBox, TrackFragmentHeaderBox, TrackFragmentRandomAccessBox, TrackHeaderBox, TrackLoadSettingsAtom, TrackProductionApertureDimensionsAtom, TrackReferenceBox, TrackReferenceTypeBox, TrackRunBox, TrickPlayBox, UnknownBox, UserBox, UserDataBox, Utf8AppleDataBox, UuidBasedProtectionSystemSpecificHeaderBox, VideoMediaHeaderBox, VisualSampleEntry, VTTAdditionalTextBox, VTTCueBox, VTTEmptyCueBox, WebVTTConfigurationBox, WebVTTSampleEntry, WebVTTSourceLabelBox, WriteOnlyBox, XmlBox, XMLSubtitleSampleEntry, XtraBox

public interface Box

Defines basic interaction possibilities for any ISO box. Each box has a parent box and a type.

Method Summary

Modifier and Type	Method and Description
void	getBox(WritableByteChannel writableByteChannel) Writes the complete box - size | 4-cc | content - to the given writableByteChannel.
long	getOffset() Returns the position of the box in the original file.
Container	getParent()
long	getSize()
String	getType() The box's 4-cc type.
void	parse(DataSource dataSource, ByteBuffer header, long contentSize, BoxParser boxParser) Parses the box excluding the already parsed header (size, 4cc, [long-size], [user-type]).
void	setParent(Container parent)

Method Detail

getParent

Container getParent()

setParent

void setParent(Container parent)

getSize

long getSize()

getOffset

long getOffset()

Returns the position of the box in the original file.

Returns:

the start offset in the source file

getType

String getType()

The box's 4-cc type.

Returns:

the 4 character type of the box

getBox

void getBox(WritableByteChannel writableByteChannel)
     throws IOException

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

Parameters:

writableByteChannel - the box's sink

Throws:

IOException - in case of problems with the Channel

parse

void parse(DataSource dataSource,
           ByteBuffer header,
           long contentSize,
           BoxParser boxParser)
    throws IOException

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.

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