Mpeg4IsoAudioSampleEntry.md

node-taglib-sharp / Exports / Mpeg4IsoAudioSampleEntry

Class: Mpeg4IsoAudioSampleEntry

This class extends IsoSampleEntry and implements IAudioCodec to provide an implementation of a ISO/IEC 14496-12 AudioSampleEntry and support for reading MPEG-4 video properties.

Hierarchy

• Mpeg4IsoSampleEntry

  ↳ Mpeg4IsoAudioSampleEntry

Implements

• IAudioCodec

Table of contents

Accessors

• audioBitrate
• audioChannels
• audioSampleRate
• audioSampleSize
• boxType
• data
• dataPosition
• dataReferenceIndex
• dataSize
• description
• durationMilliseconds
• handlerType
• hasChildren
• header
• mediaTypes
• size

Methods

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

Accessors

audioBitrate

• get audioBitrate(): number

Gets the bitrate of the audio represented by the current instance.

Returns

number

Implementation of

IAudioCodec.audioBitrate

---

audioChannels

• get audioChannels(): number

Number of channels in the audio represented by the current instance.

Returns

number

Implementation of

IAudioCodec.audioChannels

---

audioSampleRate

• get audioSampleRate(): number

Sample rate of the audio represented by the current instance.

Returns

number

Implementation of

IAudioCodec.audioSampleRate

---

audioSampleSize

• get audioSampleSize(): number

Inherit Doc

Returns

number

---

boxType

• get boxType(): ByteVector

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

Returns

ByteVector

Inherited from

IsoSampleEntry.boxType

---

data

• get data(): ByteVector

Gets the data contained in the current instance.

Returns

ByteVector

Inherited from

IsoSampleEntry.data

• set data(v): void

Sets the data contained in the current instance.

Parameters

Name	Type
v	ByteVector

Returns

void

Inherited from

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

IsoSampleEntry.dataPosition

---

dataReferenceIndex

• get dataReferenceIndex(): number

Gets the data reference index of the current instance.

Returns

number

Inherited from

IsoSampleEntry.dataReferenceIndex

---

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

IsoSampleEntry.dataSize

---

description

• get description(): string

Gets a text description of the media represented by the current instance.

Returns

string

Implementation of

IAudioCodec.description

---

durationMilliseconds

• get durationMilliseconds(): number

Duration of the media in milliseconds represented by the current instance.

Returns

number

Implementation of

IAudioCodec.durationMilliseconds

---

handlerType

• get handlerType(): ByteVector

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

Returns

ByteVector

Inherited from

IsoSampleEntry.handlerType

---

hasChildren

• get hasChildren(): boolean

Gets whether the current instance has children.

Returns

boolean

Inherited from

IsoSampleEntry.hasChildren

---

header

• get header(): Mpeg4BoxHeader

Gets the header of the current instance.

Returns

Mpeg4BoxHeader

Inherited from

IsoSampleEntry.header

---

mediaTypes

• get mediaTypes(): MediaTypes

Types of media represented by the current instance, bitwise combined.

Returns

MediaTypes

Implementation of

IAudioCodec.mediaTypes

---

size

• get size(): number

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

Returns

number

Inherited from

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

Mpeg4IsoSampleEntry.addChild

---

clearChildren

▸ clearChildren(): void

Removes all children from the current instance.

Returns

void

Inherited from

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

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

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

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

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

Mpeg4IsoSampleEntry.initializeFromHeader

---

initializeFromHeaderFileAndHandler

▸ initializeFromHeaderFileAndHandler(header, file, handlerType): void

Constructs and initializes a new instance of IsoSampleEntry with a provided header and handler by reading the contents from a specified file.

Parameters

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.

Returns

void

Inherited from

Mpeg4IsoSampleEntry.initializeFromHeaderFileAndHandler

---

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

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

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

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

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

Mpeg4IsoSampleEntry.removeChildrenByBox

---

fromFile

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

Constructs and initializes a new instance of IsoVisualSampleEntry with a provided header and handler by reading the contents from a specified file.

Parameters

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

Returns

Mpeg4IsoAudioSampleEntry