Class: Id3v2TagFooter
March 10, 2023 · View on GitHub
node-taglib-sharp / Exports / Id3v2TagFooter
Class: Id3v2TagFooter
This class provides a representation of an ID3v2 tag footer which can be read from and written to disk.
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new Id3v2TagFooter()
Properties
FILE_IDENTIFIER
▪ Static Readonly FILE_IDENTIFIER: ByteVector
Identifier used to recognize an ID3v2 footer.
Accessors
completeTagSize
• get completeTagSize(): number
Gets the complete size of the tag described by the current instance including the header and footer.
Returns
number
flags
• get flags(): Id3v2TagHeaderFlags
Gets the flags applied to the current instance.
Returns
• set flags(value): void
Sets the flags applied to the current instance.
Parameters
| Name | Type | Description |
|---|---|---|
value | Id3v2TagHeaderFlags | Bitwise combined Id3v2TagHeaderFlags value containing the flags to apply to the current instance. |
Returns
void
majorVersion
• get majorVersion(): number
Sets the major version of the tag described by the current instance.
Returns
number
• set majorVersion(value): void
Sets the major version of the tag described by the current instance. When the version is set, unsupported header flags will automatically be removed from the tag.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | ID3v2 version if tag described by the current instance. Footers are only supported with version 4, so this value can only be 4. |
Returns
void
revisionNumber
• get revisionNumber(): number
Gets the version revision number of the tag represented by the current instance.
Returns
number
• set revisionNumber(value): void
Sets the version revision number of the tag represented by the current instance. This value should always be zero. Non-zero values indicate an experimental or new version of the format which may not be completely understood by the current version of node-taglib-sharp. Some software may refuse to read tags with a non-zero value.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | Version revision number of the tag represented by the current instance. Must be an 8-bit unsigned integer. |
Returns
void
tagSize
• get tagSize(): number
Gets the complete size of the tag described by the current instance, minus the header and footer.
Returns
number
• set tagSize(value): void
Sets the complete size of the tag described by the current instance, minus the header footer. NOTE THIS MUST BE AN 28-BIT UNSIGNED INTEGER.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | Size of the tag in bytes. Must be an unsigned 28-bit integer |
Returns
void
Methods
render
▸ render(): ByteVector
Renders the current instance as a raw byte vector.
Returns
fromData
▸ Static fromData(data): Id3v2TagFooter
Constructs and initializes a new instance by reading it from raw footer data.
Parameters
| Name | Type | Description |
|---|---|---|
data | ByteVector | Raw data to build the instance from |
Returns
fromHeader
▸ Static fromHeader(header): Id3v2TagFooter
Constructs and initializes a new footer based on the contents of the header used for the same tag.
Parameters
| Name | Type | Description |
|---|---|---|
header | Id3v2TagHeader | Header from which to base the new footer |