node-taglib-sharp / Exports / 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.
-
↳
AsfContentDescriptionObject
• get author(): string
Gets the author of the media described by the current instance.
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.
| Name | Type |
|---|---|
value |
string |
void
• get copyright(): string
Gets the copyright information of the media described by the current instance.
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.
| Name | Type |
|---|---|
value |
string |
void
• get description(): string
Gets the description of the media described by the current instance.
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.
| Name | Type |
|---|---|
value |
string |
void
• get guid(): UuidWrapper
Gets the GUID that identifies the current instance.
BaseObject.guid
• get isEmpty(): boolean
Gets whether the current instance is empty.
boolean
true if all the values are cleared. Otherwise, false is returned.
• get objectType(): AsfObjectType
Gets the type of the object for easy comparison.
BaseObject.objectType
• get originalSize(): number
Gets the original size of the current instance.
number
BaseObject.originalSize
• get rating(): string
Gets the rating of the media described by the current instance.
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.
| Name | Type |
|---|---|
value |
string |
void
• get title(): string
Gets the title of the media described by the current instance.
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.
| Name | Type |
|---|---|
value |
string |
void
▸ Protected initializeFromFile(file, position): void
Initializes a new instance by reading the contents from a specified position in a specified file.
| 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 |
void
AsfBaseObject.initializeFromFile
▸ Protected initializeFromGuid(guid): void
Initializes a new instance with a specified GUID.
| Name | Type | Description |
|---|---|---|
guid |
UuidWrapper |
GUID to use for the new instance. |
void
AsfBaseObject.initializeFromGuid
▸ render(): ByteVector
Renders the current instance as a raw ASF object.
▸ 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.
| Name | Type | Description |
|---|---|---|
data |
ByteVector |
Data to store in the rendered version of the current instance. |
▸ Static fromEmpty(): AsfContentDescriptionObject
Constructs a blank content description object.
▸ Static fromFile(file, position): AsfContentDescriptionObject
Constructs a new instance by reading from a file.
| Name | Type | Description |
|---|---|---|
file |
File |
File to read the content description object from |
position |
number |
Offset into the file where the object begins |