Mpeg4TextBox.md

node-taglib-sharp / Exports / Mpeg4TextBox

Class: Mpeg4TextBox

Represents an MP4 text box

Hierarchy

• Mpeg4Box

  ↳ Mpeg4TextBox

Table of contents

Accessors

• boxType
• data
• dataPosition
• dataSize
• handlerType
• hasChildren
• header
• size

Methods

• addChild
• clearChildren
• getChild
• getChildRecursively
• getChildren
• increaseDataPosition
• initializeFromHeader
• initializeFromType
• loadData
• removeChildByBox
• removeChildByType
• removeChildrenByBox
• fromFile

Accessors

boxType

• get boxType(): ByteVector

Gets the MPEG-4 box type of the current instance.

Returns

ByteVector

Inherited from

Mpeg4Box.boxType

---

data

• get data(): ByteVector

Gets the data contained in the current instance.

Returns

ByteVector

Inherited from

Mpeg4Box.data

• set data(v): void

Sets the data contained in the current instance.

Parameters

Name	Type
v	ByteVector

Returns

void

Inherited from

Mpeg4Box.data

---

dataPosition

• get dataPosition(): number

Gets the position of the data contained in the current instance, after any box specific headers.

Returns

number

Inherited from

Mpeg4Box.dataPosition

---

dataSize

• get dataSize(): number

Gets the size of the data contained in the current instance, minus the size of any box specific headers.

Returns

number

Inherited from

Mpeg4Box.dataSize

---

handlerType

• get handlerType(): ByteVector

Gets the type of the handler box that applies to the current instance.

Returns

ByteVector

Inherited from

Mpeg4Box.handlerType

---

hasChildren

• get hasChildren(): boolean

Gets whether the current instance has children.

Returns

boolean

Inherited from

Mpeg4Box.hasChildren

---

header

• get header(): Mpeg4BoxHeader

Gets the header of the current instance.

Returns

Mpeg4BoxHeader

Inherited from

Mpeg4Box.header

---

size

• get size(): number

Gets the total size of the current instance as it last appeared on disk.

Returns

number

Inherited from

Mpeg4Box.size

Methods

addChild

▸ addChild(box): void

Adds a specified box to the current instance.

See

Mpeg4Box object to add to the current instance.

Parameters

Name	Type	Description
box	Mpeg4Box	A

Returns

void

Inherited from

Mpeg4Box.addChild

---

clearChildren

▸ clearChildren(): void

Removes all children from the current instance.

Returns

void

Inherited from

Mpeg4Box.clearChildren

---

getChild

▸ 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.

Type parameters

Name	Type
TBox	extends Mpeg4Box<TBox>

Parameters

Name	Type	Description
type	ByteVector	A
predicate?	(b: TBox) => boolean	Optional predicate to filter boxes with the provided type.

Returns

TBox

TBox Box containing the matched box, or undefined if no match was found.

Inherited from

Mpeg4Box.getChild

---

getChildRecursively

▸ 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.

Parameters

Name	Type	Description
type	ByteVector	A

Returns

Mpeg4Box

Mpeg4Box Matching box, or undefined if no matching box was found

Inherited from

Mpeg4Box.getChildRecursively

---

getChildren

▸ 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.

Type parameters

Name	Type
TBox	extends Mpeg4Box<TBox>

Parameters

Name	Type	Description
type	ByteVector	A
predicate?	(b: TBox) => boolean	Optional predicate to filter boxes with the provided type.

Returns

TBox[]

Mpeg4Box[] Array of matching boxes, or undefined if no matching boxes was found.

Inherited from

Mpeg4Box.getChildren

---

increaseDataPosition

▸ 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.

Parameters

Name	Type	Description
value	number	The value to add to the data position.

Returns

number

number Data position before the increase.

Inherited from

Mpeg4Box.increaseDataPosition

---

initializeFromHeader

▸ Protected initializeFromHeader(header, handlerType?): void

Initializes a new instance of

See

• Mpeg4Box with a specified header and handler.
• Mpeg4BoxHeader object describing the new instance.

Parameters

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.

Returns

void

Inherited from

Mpeg4Box.initializeFromHeader

---

initializeFromType

▸ 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.

Parameters

Name	Type	Description
type	ByteVector	A

Returns

void

Inherited from

Mpeg4Box.initializeFromType

---

loadData

▸ 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.

Parameters

Name	Type	Description
file	File	The

Returns

ByteVector

ByteVector Data read from the file.

Inherited from

Mpeg4Box.loadData

---

removeChildByBox

▸ removeChildByBox(box): void

Removes a specified box from the current instance.

Parameters

Name	Type	Description
box	Mpeg4Box	Box to remove from the current instance.

Returns

void

Inherited from

Mpeg4Box.removeChildByBox

---

removeChildByType

▸ removeChildByType(type): void

Removes all children with a specified box type from the current instance.

Parameters

Name	Type	Description
type	ByteVector	Type of box to remove

Returns

void

Inherited from

Mpeg4Box.removeChildByType

---

removeChildrenByBox

▸ removeChildrenByBox(boxes): void

Removes all specified boxes from the current instance.

Parameters

Name	Type	Description
boxes	Mpeg4Box[]	Collection of boxes to remove from the current instance.

Returns

void

Inherited from

Mpeg4Box.removeChildrenByBox

---

fromFile

▸ Static fromFile(header, file, handlerType): Mpeg4TextBox

Constructs and initializes a new instance of

See

• TextBox with a provided header and handler by reading the contents from a specified file.
• Mpeg4BoxHeader object containing the header to use for the new instance.
• File object to read the contents of the box from.

Parameters

Name	Type	Description
header	Mpeg4BoxHeader	A
file	File	A
handlerType	ByteVector	Type of the handler box object containing the handler that applies to the new instance, or undefined if no handler applies.

Returns

Mpeg4TextBox