node-taglib-sharp / Exports / Id3v2TextInformationFrame
This class provides support for ID3v2 text information frames (section 4.2) covering T000 to
TZZZ, excluding TXXX.
Text information frames contain the most commonly used values in tagging, including the artist,
track name, and just about any value that can be expressed as text. The following table contains
types and descriptions as found in the ID3 2.4.0 native frames specification (Copyright Martin
Nilsson 2000).
- TIT1 - The "Content Group Description" frame is used if the sound belongs to a larger category of sounds/music. For example, classical music is often sorted in different musical sections (eg, "Piano Concerto", "Weather - Hurricane").
- TIT2 - The "Title/Song name/Content description" frame is the actual name of the piece (eg, "Adagio", "Hurricane Donna").
- TIT3 - The "Subtitle/Description refinement" frame is used for information directly related to the contents title (eg, "Op. 16" or "Performed Live at Wembley").
- TALB - The "Album/Movie/Show title" frame is intended for the title of the recording (or source of sound) from which the audio in the file is taken.
- TOAL - The "Original album/movie/show title" frame is intended for the title of the original recording (or source of sound), if for example the music in the file should be a cover of a previously released song.
- TRCK - The "Track number/Position in set" frame is a numeric string containing the order number of the audio-file on its original recording. This MAY be extended with a "/" character and a numeric string containing the total number of tracks/elements on the original recording (eg "4/9").
- TPOS - The "Part of a set" frame is a numeric string that describes which part of a set the audio came from. This frame is used if the source described in the "TLAB" frame is divided into several mediums, eg, a double CD. The value MAY be extended with a "/" character and a numeric string containing the total number of parts in the set (eg, "1/2").
- TSST - The "Set Subtitle" frame is intended for the subtitle of the part of a set this track belongs to.
- TSRC - The "ISRC" frame should contain the International Standard Recording Code (12 chars).
- TPE1 - The "Lead artist/Lead performer/Soloist/Performing Group" frame is used for the main artist.
- TPE2 - The "Band/Orchestra/Accompaniment" frame is used for additional information about the performers in the recording.
- TPE3 - The "Conductor" frame is used for the name of the conductor.
- TPE4 - The "Interpreted, remixed, or otherwise modified by" frame contains more information about the people behind a remix and similar interpretations of another existing piece.
- TOPE - The "Original artist/Performer" frame is intended for the performer of the original recording, if for example the music in the file should be a cover of a previously released song.
- TEXT - The "Lyricist/Text writer" frame is intended for the writer of the text or lyrics in the recording.
- TOLY - The "Original lyricist/Text writer" frame is intended for the text writer of the original recording, if for example the music in the file should be a cover of a previously released song.
- TCOM - The "composer" frame is intended for the name of the composer.
- TMCL - The "musician credits list" frame is intended as a mapping betweenInclusive instruments and the musician who played it. Every odd field is an instrument and every even is an artist of a comma-delimited list of artists.
- TIPL - The "Involved people list" frame is very similar to the musician credits list, but maps betweenInclusive functions, like producer, and names.
- TENC - The "Encoded by" frame contains the name of the person or organization that encoded the audio file. This field may contain a copyright message, if the audio file is also copyrighted by the encoder.
- TBPM - The "BPM" frame contains the number of beats per minute in the main part of the audio. The BPM is an integer and represented as a numeric string.
- TLEN - The "Length" frame contains the length of the audio file in milliseconds, represented as a numeric string.
- TKEY - The "Initial key" frame contains the musical key in which the sound starts. It is represented as a string with a maximum length of 3 characters. The ground keys are represented with "A" - "G" and half keys are represented with "b" or "#". Minor is represented as "m", eg, "Dbm". Off-key is represented with an "o" only.
- TLAN - The "language" frame should contain the languages of the text or lyrics spoken or sung in the audio. The language is represented with three characters according to ISO-639-2. If more than one language is used in the text, the language codes should follow according to the amount of usage.
- TCON - The "Content type" frame, which in ID3v1 was stored as one byte numeric value only, is now a string. You may use one or several of the ID3v1 types as numeric strings, or, since the category list would be impossible to maintain with accurate and up-to-date categories, define your own.
- TFLT - The "File type" frame indicates which type of audio this tag defines. (see the specification for more details)
- TMED - The "Media type" frame describes from which media the sound originated. (see the specification for more details)
- TMOO - The "mood" frame is intended to reflect the mood of the audio with a few keywords (eg, "Romantic" or "Sad").
- TCOP - The "Copyright message" frame, in which the string must begin with a year and a space character (making 5 characters), is intended for the copyright holder of the original sound, not the audio file itself. The absence of this frame means only that the copyright information is unavailable or has been removed, and must not be interpreted to mean that the audio is public domain. Every time this field is displayed, the field must be preceded with "Copyright " (C) " ", where (C) is one character showing the copyright mark.
- TPRO - The "Produced notice" frame, in which the string must begin with a year and a space character (making 5 characters), is intended for the production copyright holder of the production copyright holder of the original sound, not the audio file itself. Every time this field is displayed, the field must be preceded with "Produced " (P) " ", where (P) is one character showing the sound recording copyright symbol.
- TPUB - The "Publisher" frame contains the name of the label or publisher.
- TOWN - The "file owner/licensee" frame containing the name of the owner or licensee of the file and its contents.
- TRSN - The "Internet radio station name" frame contains the name of the internet radio station from which the audio is streamed.
- TRSO - The "Internet radio station owner" frame contains the name of the owner of the internet radio station from which the audio is streamed.
- TOFN - The "Original filename" frame contains the preferred filename for the file, since some media doesn't allow the desired length of the filename. The filename is case-sensitive and includes its extension.
- TDLY - The "Playlist delay" frame defines the numbers of milliseconds of silence that should be inserted before this audio. The value zero indicates that this is a part of a multi-file audio track that should be played continuously.
- TDEN - The "Encoding time" frame contains a timestamp describing when the audio was encoded. Timestamp format is described in the ID3v2 structure document.
- TDOR - The "Original release time" frame contains a timestamp describing when the original recording was released. Timestamp format is described in the ID3v2 structure document.
- TDRC - The "Recording time" frame contains a timestamp describing when the audio was recorded. Timestamp format is described in the ID3v2 structure document.
- TDRL - The "Release time" frame contains a timestamp describing when the audio was first released. Timestamp format is described in the ID3v2 structure document.
- TDTG - The "Tagging time" frame contains a timestamp describing when the audio was tagged. Timestamp format is described in the ID3v2 structure document.
- TSSE - The "Software/Hardware and settings used for encoding" frame includes the used audio encoder and its settings when the file was encoded. Hardware refers to hardware encoders, not the computer on which an encoding program ran.
- TSOA - The "Album sort order" frame defines a string which should be used instead of the album name (TALB) for sorting purposes. For example, an album named "A Soundtrack" might be preferably sorted as "Soundtrack".
- TSOP - The "Performer sort order" frame defines a string which should be used instead of the performer (TPE2) for sorting purposes.
- TSOT - The "Title sort order" frame defines a string which should be used instead of the title (TIT2) for sorting purposes.
-
↳
Id3v2TextInformationFrame
- clone
- fieldData
- parseFields
- parseRawData
- render
- renderFields
- setData
- toString
- correctEncoding
- findTextInformationFrame
- fromIdentifier
- fromOffsetRawData
- fromRawData
• Protected new Id3v2TextInformationFrame(header)
| Name | Type |
|---|---|
header |
Id3v2FrameHeader |
• Protected _encoding: StringType = Id3v2Settings.defaultEncoding
Text encoding to use to store the text contents of the current instance.
• Protected _rawData: ByteVector
Raw data contents in the current instance.
• Protected _rawVersion: number
ID3v2 version of the current instance.
• Protected _textFields: string[] = []
Decoded text contained in the current instance.
• get encryptionId(): number
Gets the encryption ID applied to the current instance.
number
Value containing the encryption identifier for the current instance or
undefined if not set.
Frame.encryptionId
• set encryptionId(value): void
Sets the encryption ID applied to the current instance.
| Name | Type | Description |
|---|---|---|
value |
number |
Value containing the encryption identifier for the current instance. Must be an 8-bit unsigned integer. Setting to undefined will remove the encryption header and ID |
void
Frame.encryptionId
• get flags(): Id3v2FrameFlags
Gets the frame flags applied to the current instance.
Frame.flags
• set flags(value): void
Sets the frame flags applied to the current instance. If the value includes either Encryption or Compression, render will throw.
| Name | Type |
|---|---|
value |
Id3v2FrameFlags |
void
Frame.flags
• get frameClassType(): Id3v2FrameClassType
Gets a flag indicating which type of frame the current instance is.
Frame.frameClassType
• get frameId(): Id3v2FrameIdentifier
Gets the frame ID for the current instance.
Object representing of the identifier of the frame
Frame.frameId
• get groupId(): number
Gets the grouping ID applied to the current instance.
number
Value containing the grouping identifier for the current instance, or
undefined if not set.
Frame.groupId
• set groupId(value): void
Sets the grouping ID applied to the current instance.
| Name | Type | Description |
|---|---|---|
value |
number |
Grouping identifier for the current instance. Must be an 8-bit unsigned integer. Setting to undefined will remove the grouping identity header and ID |
void
Frame.groupId
• Protected get header(): Id3v2FrameHeader
Gets the header for the frame. For new frames this should not exist.
Frame.header
• Protected set header(value): void
Sets the header for the frame.
| Name | Type | Description |
|---|---|---|
value |
Id3v2FrameHeader |
Header for the frame |
void
Frame.header
• get size(): number
Gets the size of the current instance as it was last stored on disk. NOTE: This value is not used outside of reading a frame from disk, so newly created frames should not have this value set.
number
Frame.size
• get text(): string[]
Gets the text contained in the current instance. Note: Modifying the contents of the returned value will not modify the contents of the current instance. The value must be reassigned for the value to change.
string[]
• set text(value): void
Sets the text contained in the current instance.
| Name | Type |
|---|---|
value |
string[] |
void
• get textEncoding(): StringType
Gets the text encoding to use when rendering the current instance.
• set textEncoding(value): void
Sets the text encoding to use when rendering the current instance.
This value will be overridden if forceDefaultEncoding is true.
| Name | Type |
|---|---|
value |
StringType |
void
▸ clone(): Id3v2Frame
Creates a deep copy of the current instance. This method is implemented by rendering the current instance as an ID3v2.4 frame and using the frame factory to create a new frame. As such, this method should be overridden by child classes.
▸ Protected fieldData(frameData, offset, version, dataIncludesHeader): ByteVector
Extracts the field data from the raw portion of an ID3v2 frame. This method is necessary for extracting extra data prepended to the frame such the as grouping ID.
| Name | Type | Description |
|---|---|---|
frameData |
ByteVector |
Raw frame data |
offset |
number |
Index at which the data is contained |
version |
number |
Version of the ID3v2 tag the data was originally encoded with |
dataIncludesHeader |
boolean |
true if frameData includes the header, false otherwise |
▸ Protected parseFields(data, version): void
Populates the values in this frame by parsing its field data in a specified version.
| Name | Type | Description |
|---|---|---|
data |
ByteVector |
Extracted field data |
version |
number |
ID3v2 version the field data is encoded in |
void
▸ Protected parseRawData(): void
Performs the actual parsing of the raw data. Because of the high parsing cost and relatively low usage of the class parseFields only stores the field data so it can be parsed on demand. Whenever a property or method is called which requires the data, this method is called, and only on the first call does it actually parse the data.
void
▸ render(version): ByteVector
Renders the current instance, encoded in a specified ID3v2 version.
| Name | Type | Description |
|---|---|---|
version |
number |
ID3v2 version to use when encoding the current instance. Must be a positive 8-bit integer. |
Rendered version of the current instance.
▸ Protected renderFields(version): ByteVector
Renders the values in the current instance into field data for a specified version.
| Name | Type | Description |
|---|---|---|
version |
number |
ID3v2 version the field data is to be encoded in. |
▸ Protected setData(data, offset, readHeader, version): void
Populates the current instance by reading the raw frame from disk, optionally reading the header.
| Name | Type | Description |
|---|---|---|
data |
ByteVector |
Raw ID3v2 frame |
offset |
number |
Offset in data at which the frame begins. |
readHeader |
boolean |
Whether or not to read the reader into the current instance. |
version |
number |
Version of the ID3v2 tag the data was encoded with |
void
▸ toString(): string
Returns a text representation of the current instance by combining the text with semicolons.
string
▸ Static Protected correctEncoding(type, version): StringType
Converts an encoding to be a supported encoding for a specified tag version.
| Name | Type | Description |
|---|---|---|
type |
StringType |
Value containing the original encoding |
version |
number |
Value containing the ID3v2 version to be encoded. |
Value containing the correct encoding to use, based on
forceDefaultEncoding and what is supported by
version
▸ Static findTextInformationFrame(frames, ident): Id3v2TextInformationFrame
Gets a TextInformationFrame object of a specified type from a specified type from a list of text information frames.
| Name | Type | Description |
|---|---|---|
frames |
Id3v2TextInformationFrame[] |
List of frames to search |
ident |
Id3v2FrameIdentifier |
Frame identifier to search for |
Matching frame if it exists in tag, undefined if a matching frame was not found
▸ Static fromIdentifier(identifier, encoding?): Id3v2TextInformationFrame
Constructs and initializes a new instance with a specified identifier
| Name | Type | Default value | Description |
|---|---|---|---|
identifier |
Id3v2FrameIdentifier |
undefined |
Byte vector containing the identifier for the frame |
encoding |
StringType |
Id3v2Settings.defaultEncoding |
Optionally, the encoding to use for the new instance. If omitted, defaults to defaultEncoding |
▸ Static fromOffsetRawData(data, offset, header, version): Id3v2TextInformationFrame
Constructs and initializes a new instance by reading its raw data in a specified ID3v2 version. This method allows for offset reading from the data byte vector.
| Name | Type | Description |
|---|---|---|
data |
ByteVector |
Raw representation of the new frame |
offset |
number |
What offset in data the frame actually begins. Must be positive, safe integer |
header |
Id3v2FrameHeader |
Header of the frame found at data in the data |
version |
number |
ID3v2 version the frame was originally encoded with |
▸ Static fromRawData(data, version): Id3v2TextInformationFrame
Constructs and initializes a new instance by reading its raw data in a specified ID3v2 version.
| Name | Type | Description |
|---|---|---|
data |
ByteVector |
Raw representation of the new frame |
version |
number |
ID3v2 version the raw frame is encoded with, must be a positive 8-bit integer |