node-taglib-sharp / Exports / AsfContentDescriptionObject

Class: AsfContentDescriptionObject

This class extends BaseObject to provide a representation of an ASF content description object. The content description object is optional and provides standard bibliographic information such as title, author, copyright, description, rating information.

Hierarchy

• AsfBaseObject

  ↳ AsfContentDescriptionObject

Table of contents

Accessors

• author
• copyright
• description
• guid
• isEmpty
• objectType
• originalSize
• rating
• title

Methods

• initializeFromFile
• initializeFromGuid
• render
• renderInternal
• fromEmpty
• fromFile

Accessors

author

• get author(): string

Gets the author of the media described by the current instance.

Returns

string

Author of the media or undefined if it is not set.

• set author(value): void

Sets the author of the media described by the current instance.

Parameters

Name	Type
value	string

Returns

void

---

copyright

• get copyright(): string

Gets the copyright information of the media described by the current instance.

Returns

string

Copyright information of the media or undefined if it is not set.

• set copyright(value): void

Sets the copyright information of the media described by the current instance.

Parameters

Name	Type
value	string

Returns

void

---

description

• get description(): string

Gets the description of the media described by the current instance.

Returns

string

Description of the media or undefined if it is not set.

• set description(value): void

Sets the description of the media described by the current instance.

Parameters

Name	Type
value	string

Returns

void

---

guid

• get guid(): UuidWrapper

Gets the GUID that identifies the current instance.

Returns

UuidWrapper

Inherited from

BaseObject.guid

---

isEmpty

• get isEmpty(): boolean

Gets whether the current instance is empty.

Returns

boolean

true if all the values are cleared. Otherwise, false is returned.

---

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

---

rating

• get rating(): string

Gets the rating of the media described by the current instance.

Returns

string

Rating of the media or undefined if it is not set.

• set rating(value): void

Sets the rating of the media described by the current instance.

Parameters

Name	Type
value	string

Returns

void

---

title

• get title(): string

Gets the title of the media described by the current instance.

Returns

string

Title of the media or undefined if it is not set.

• set title(value): void

Sets the title of the media described by the current instance.

Parameters

Name	Type
value	string

Returns

void

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

---

fromEmpty

▸ Static fromEmpty(): AsfContentDescriptionObject

Constructs a blank content description object.

Returns

AsfContentDescriptionObject

---

fromFile

▸ Static fromFile(file, position): AsfContentDescriptionObject

Constructs a new instance by reading from a file.

Parameters

Name	Type	Description
file	File	File to read the content description object from
position	number	Offset into the file where the object begins

Returns

AsfContentDescriptionObject