AsfStreamPropertiesObject.md

node-taglib-sharp / Exports / AsfStreamPropertiesObject

Class: AsfStreamPropertiesObject

This class provides a representation of an ASF properties object which can be read from and written to disk.

Hierarchy

• AsfBaseObject

  ↳ AsfStreamPropertiesObject

Table of contents

Accessors

• codec
• errorCorrectionData
• errorCorrectionType
• flags
• guid
• objectType
• originalSize
• streamNumber
• streamType
• timeOffsetMilliseconds
• typeSpecificData

Methods

• initializeFromFile
• initializeFromGuid
• render
• renderInternal
• fromFile

Accessors

codec

• get codec(): ICodec

Gets the codec information contained in the current instance.

Returns

ICodec

---

errorCorrectionData

• get errorCorrectionData(): ByteVector

Gets the error correction data contained in the current instance.

Returns

ByteVector

---

errorCorrectionType

• get errorCorrectionType(): UuidWrapper

Gets the error correction type GUID of the current instance.

Returns

UuidWrapper

---

flags

• get flags(): number

Gets the flags that apply to the current instance.

Remarks

The flags field a 16-bit, double word, defined as follows: * LSB * Stream number - 7 bits * Reserved - 8 bits * Encrypted content flag - 1 bit

Returns

number

---

guid

• get guid(): UuidWrapper

Gets the GUID that identifies the current instance.

Returns

UuidWrapper

Inherited from

BaseObject.guid

---

objectType

• get objectType(): AsfObjectType

Gets the type of the object for easy comparison.

Returns

AsfObjectType

Overrides

BaseObject.objectType

---

originalSize

• get originalSize(): number

Gets the original size of the current instance.

Returns

number

Inherited from

BaseObject.originalSize

---

streamNumber

• get streamNumber(): number

Gets the stream number for the current instance. Zero is invalid.

Returns

number

---

streamType

• get streamType(): UuidWrapper

Gets the stream type GUID of the current instance.

Returns

UuidWrapper

---

timeOffsetMilliseconds

• get timeOffsetMilliseconds(): number

Gets the time offset at which the stream described by the current instance begins.

Returns

number

---

typeSpecificData

• get typeSpecificData(): ByteVector

Gets the type specific data contained in the current instance.

Remarks

The parsed version of this data is available in codec.

Returns

ByteVector

Methods

initializeFromFile

▸ Protected initializeFromFile(file, position): void

Initializes a new instance by reading the contents from a specified position in a specified file.

Parameters

Name	Type	Description
file	File	File which contains the details of the new instance to create
position	number	Position in file where the object begins

Returns

void

Inherited from

AsfBaseObject.initializeFromFile

---

initializeFromGuid

▸ Protected initializeFromGuid(guid): void

Initializes a new instance with a specified GUID.

Parameters

Name	Type	Description
guid	UuidWrapper	GUID to use for the new instance.

Returns

void

Inherited from

AsfBaseObject.initializeFromGuid

---

render

▸ render(): ByteVector

Renders the current instance as a raw ASF object.

Returns

ByteVector

Overrides

AsfBaseObject.render

---

renderInternal

▸ Protected renderInternal(data): ByteVector

Renders the current instance as a raw ASF object containing the specified data.

Remarks

Child classes implementing () should render their contents and then send the data through this method to produce the final output.

Parameters

Name	Type	Description
data	ByteVector	Data to store in the rendered version of the current instance.

Returns

ByteVector

Inherited from

AsfBaseObject.renderInternal

---

fromFile

▸ Static fromFile(file, position): AsfStreamPropertiesObject

Constructs and initializes a new instance by reading contents from a specified position in the provided file.

Parameters

Name	Type	Description
file	File	File from which the contents of the new instance will be read
position	number	Index into the file where the stream properties object begins

Returns

AsfStreamPropertiesObject