node-taglib-sharp / Exports / AsfMetadataDescriptor

Class: AsfMetadataDescriptor

This class provides a representation of an ASF description record to be used inside a MetadataLibraryObject.

Remarks

This class can store various types of information. Although toString provides a representation of all types of values, it is recommended to determine which of the get* methods to use by accessing type

Hierarchy

• DescriptorBase

  ↳ AsfMetadataDescriptor

Table of contents

Constructors

• constructor

Accessors

• boolValue
• byteValue
• guidValue
• languageListIndex
• name
• streamNumber
• stringValue
• type
• uintValue
• ulongValue
• ushortValue

Methods

• render
• toString

Constructors

constructor

• new AsfMetadataDescriptor(languageListIndex, streamNumber, name, type, value)

Constructs and initializes a new instance.

Parameters

Name	Type	Description
languageListIndex	number	Index of the language
streamNumber	number	Index of the stream
name	string	Name of the metadata library object
type	AsfObjectDataType	Datatype of the object
value	AsfDescriptorValue	Value to store in the instance

Overrides

DescriptorBase.constructor

Accessors

boolValue

• get boolValue(): boolean

Gets the boolean value of the current instance.

Returns

boolean

Boolean value of the current instance is returned if type is DataType.Bool. undefined is returned otherwise.

Inherited from

DescriptorBase.boolValue

---

byteValue

• get byteValue(): ByteVector

Gets the binary contents of the current instance.

Returns

ByteVector

Byte contents of the current instance, if type is DataType.Bytes. undefined is returned otherwise.

Inherited from

DescriptorBase.byteValue

---

guidValue

• get guidValue(): UuidWrapper

Gets the guid contents of the current instance.

Returns

UuidWrapper

GUID contents of the current instance, if type is DataType.Guid. undefined is returned otherwise.

Inherited from

DescriptorBase.guidValue

---

languageListIndex

• get languageListIndex(): number

Gets the index of the language associated with the current instance.

Returns

number

---

name

• get name(): string

Gets the name of the current instance.

Returns

string

Inherited from

DescriptorBase.name

---

streamNumber

• get streamNumber(): number

Gets the index of the stream associated with the current instance.

Returns

number

---

stringValue

• get stringValue(): string

Gets the string contents of the current instance.

Returns

string

String contents of the current instance if type is DataType.Unicode. undefined is returned otherwise.

Inherited from

DescriptorBase.stringValue

---

type

• get type(): AsfObjectDataType

Gets the type of data contained in the current instance.

Returns

AsfObjectDataType

Inherited from

DescriptorBase.type

---

uintValue

• get uintValue(): number

Gets the 32-bit double word contents of the current instance.

Returns

number

Double word contents of the current instance, if type is DataType.DWord. undefined is returned otherwise.

Inherited from

DescriptorBase.uintValue

---

ulongValue

• get ulongValue(): bigint

Gets the 64-bit quad word contents of the current instance.

Returns

bigint

Quad word contents of the current instance, if type is DataType.QWord. undefined is returned otherwise.

Inherited from

DescriptorBase.ulongValue

---

ushortValue

• get ushortValue(): number

Gets the 16-bit word contents of the current instance.

Returns

number

Word contents of the current instance, if type is DataType.Word. undefined is returned otherwise.

Inherited from

DescriptorBase.ushortValue

Methods

render

▸ render(): ByteVector

Inherit Doc

Returns

ByteVector

Overrides

DescriptorBase.render

---

toString

▸ toString(): string

Inherit Doc

Returns

string

Inherited from

DescriptorBase.toString