node-taglib-sharp / Exports / Mpeg4AppleAdditionalInfoBox
This class extends FullBox to provide an implementation of an Apple AdditionalInfoBox.
-
↳
Mpeg4AppleAdditionalInfoBox
- addChild
- clearChildren
- getChild
- getChildRecursively
- getChildren
- increaseDataPosition
- initializeFromHeader
- initializeFromHeaderFileAndHandler
- initializeFromType
- initializeFromTypeVersionAndFlags
- loadData
- removeChildByBox
- removeChildByType
- removeChildrenByBox
- fromFile
- fromTypeVersionAndFlags
• get
boxType(): ByteVector
Gets the MPEG-4 box type of the current instance.
FullBox.boxType
• get
data(): ByteVector
Gets the data contained in the current instance.
FullBox.data
• set
data(v
): void
Sets the data contained in the current instance.
Name | Type |
---|---|
v |
ByteVector |
void
FullBox.data
• get
dataPosition(): number
Gets the position of the data contained in the current instance, after any box specific headers.
number
FullBox.dataPosition
• get
dataSize(): number
Gets the size of the data contained in the current instance, minus the size of any box specific headers.
number
FullBox.dataSize
• get
flags(): number
Gets the flags that apply to the current instance.
number
FullBox.flags
• set
flags(value
): void
Sets the flags that apply to the current instance.
Name | Type |
---|---|
value |
number |
void
FullBox.flags
• get
handlerType(): ByteVector
Gets the type of the handler box that applies to the current instance.
FullBox.handlerType
• get
hasChildren(): boolean
Gets whether or not the current instance has children.
boolean
FullBox.hasChildren
• get
header(): Mpeg4BoxHeader
Gets the header of the current instance.
FullBox.header
• get
size(): number
Gets the total size of the current instance as it last appeared on disk.
number
FullBox.size
• get
text(): string
Gets the text contained in the current instance.
string
• set
text(v
): void
Sets the text contained in the current instance.
Name | Type |
---|---|
v |
string |
void
• get
version(): number
Gets the version number of the current instance.
number
FullBox.version
▸ addChild(box
): void
Adds a specified box to the current instance.
See
Mpeg4Box object to add to the current instance.
Name | Type | Description |
---|---|---|
box |
Mpeg4Box |
A |
void
▸ clearChildren(): void
Removes all children from the current instance.
void
▸ getChild<TBox
>(type
, predicate?
): TBox
Gets a child box from the current instance by finding a matching box type.
See
ByteVector object containing the box type to match.
Name | Type |
---|---|
TBox |
extends Mpeg4Box <TBox > |
Name | Type | Description |
---|---|---|
type |
ByteVector |
A |
predicate? |
(b : TBox ) => boolean |
Optional predicate to filter boxes with the provided type. |
TBox
TBox Box containing the matched box, or undefined
if no match was found.
▸ getChildRecursively(type
): Mpeg4Box
Gets a child box from the current instance by finding a matching box type, searching recursively.
See
ByteVector object containing the box type to match.
Name | Type | Description |
---|---|---|
type |
ByteVector |
A |
Mpeg4Box Matching box, or undefined
if no matching box was found
Mpeg4FullBox.getChildRecursively
▸ getChildren<TBox
>(type
, predicate?
): TBox
[]
Gets all child boxes from the current instance by finding a matching box type.
See
ByteVector object containing the box type to match.
Name | Type |
---|---|
TBox |
extends Mpeg4Box <TBox > |
Name | Type | Description |
---|---|---|
type |
ByteVector |
A |
predicate? |
(b : TBox ) => boolean |
Optional predicate to filter boxes with the provided type. |
TBox
[]
Mpeg4Box[] Array of matching boxes, or undefined
if no matching boxes was found.
▸ increaseDataPosition(value
): number
Increases the data position by a given value. This function can be used by boxes which extend from
See
Mpeg4Box to increase the data position, because the data is located after their box specific headers.
Name | Type | Description |
---|---|---|
value |
number |
The value to add to the data position. |
number
number Data position before the increase.
Mpeg4FullBox.increaseDataPosition
▸ Protected
initializeFromHeader(header
, handlerType?
): void
Initializes a new instance of
See
- Mpeg4Box with a specified header and handler.
- Mpeg4BoxHeader object describing the new instance.
Name | Type | Description |
---|---|---|
header |
Mpeg4BoxHeader |
A |
handlerType? |
ByteVector |
Type of the handler box object containing the handler that applies to the new instance, or undefined if no handler applies. |
void
Mpeg4FullBox.initializeFromHeader
▸ Protected
initializeFromHeaderFileAndHandler(header
, file
, handlerType
): void
Initializes a new instance of FullBox with a provided header and handler by reading the contents from a specified file.
Name | Type | Description |
---|---|---|
header |
Mpeg4BoxHeader |
A Mpeg4BoxHeader object containing the header to use for the new instance. |
file |
File |
A File object to read the contents of the box from. |
handlerType |
ByteVector |
Type of the handler box object containing the handler that applies to the new instance, or undefined if no handler applies. |
void
Mpeg4FullBox.initializeFromHeaderFileAndHandler
▸ Protected
initializeFromType(type
): void
Initializes a new instance of
See
- Mpeg4Box with a specified box type.
- ByteVector object containing the box type to use for the new instance.
Name | Type | Description |
---|---|---|
type |
ByteVector |
A |
void
Mpeg4FullBox.initializeFromType
▸ Protected
initializeFromTypeVersionAndFlags(type
, version
, flags
): void
Initializes a new instance of FullBox with a provided header, version, and flags.
Name | Type | Description |
---|---|---|
type |
ByteVector |
A ByteVector object containing the four byte box type. |
version |
number |
A value containing the version of the new instance. |
flags |
number |
A value containing the flags for the new instance. |
void
Mpeg4FullBox.initializeFromTypeVersionAndFlags
▸ loadData(file
): ByteVector
Loads the data of the current instance from a specified file using the internal data position and size.
See
File from which the current instance was read and from which to read the data.
Name | Type | Description |
---|---|---|
file |
File |
The |
ByteVector Data read from the file.
▸ removeChildByBox(box
): void
Removes a specified box from the current instance.
Name | Type | Description |
---|---|---|
box |
Mpeg4Box |
Box to remove from the current instance. |
void
▸ removeChildByType(type
): void
Removes all children with a specified box type from the current instance.
Name | Type | Description |
---|---|---|
type |
ByteVector |
Type of box to remove |
void
Mpeg4FullBox.removeChildByType
▸ removeChildrenByBox(boxes
): void
Removes all specified boxes from the current instance.
Name | Type | Description |
---|---|---|
boxes |
Mpeg4Box [] |
Collection of boxes to remove from the current instance. |
void
Mpeg4FullBox.removeChildrenByBox
▸ Static
fromFile(header
, file
, handlerType
): Mpeg4AppleAdditionalInfoBox
Constructs and initializes a new instance of AppleAdditionalInfoBox with a provided header and handler by reading the contents from a specified file.
Name | Type | Description |
---|---|---|
header |
Mpeg4BoxHeader |
A Mpeg4BoxHeader object containing the header to use for the new instance. |
file |
File |
A File object to read the contents of the box from. |
handlerType |
ByteVector |
Type of the handler box object containing the handler that applies to the new instance, or undefined if no handler applies. |
▸ Static
fromTypeVersionAndFlags(type
, version
, flags
): Mpeg4AppleAdditionalInfoBox
Constructs and initializes a new instance of FullBox with a provided header, version, and flags.
Name | Type | Description |
---|---|---|
type |
ByteVector |
A Mpeg4BoxHeader object containing the header to use for the new instance. |
version |
number |
A value containing the version of the new instance. |
flags |
number |
A value containing the flags for the new instance. |