ID3V2Tag class

ID3V2Tag class

Represents an ID3v2 tag. Please find more information at https://en.wikipedia.org/wiki/ID3#ID3v2.

Inheritance: ID3V2Tag → ID3Tag → CustomPackage → MetadataPackage

The ID3V2Tag type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of the ID3V2Tag class.

Properties

Property Description
metadata_type Gets the metadata type.
keys Gets a collection of the metadata property names.
property_descriptors Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
count Gets the number of metadata properties.
version Gets the ID3 version.
tag_size Gets the size of the tag.
album Gets or sets the Album/Movie/Show title.
This value is represented by the TALB frame.
artist Gets or sets the Lead artist(s)/Lead performer(s)/Soloist(s)/Performing group.
This value is represented by the TPE1 frame.
band Gets or sets the Band/Orchestra/Accompaniment.
This value is represented by the TPE2 frame.
bits_per_minute Gets or sets the number of beats per minute in the main part of the audio.
This value is represented by the TBPM frame.
composers Gets or sets the composers. The names are separated with the “/” character.
This value is represented by the TCOM frame.
content_type Gets or sets the content type.
This value is represented by the TCON frame.
copyright Gets or sets the copyright message.
This value is represented by the TCOP frame.
date Gets or sets a numeric string in the DDMM format containing the date for the recording. This field is always four characters long.
This value is represented by the TDAT frame.
encoded_by Gets or sets the name of the person or organization that encoded the audio file.
This value is represented by the TENC frame.
publisher Gets or sets the name of the label or publisher.
This value is represented by the TPUB frame.
time Gets or sets a numeric string in the HHMM format containing the time for the recording. This field is always four characters long.
This value is represented by the TIME frame.
title Gets or sets the Title/Song name/Content description.
This value is represented by the TIT2 frame.
subtitle Gets or sets the Subtitle/Description refinement.
This value is represented by the TIT3 frame.
musical_key Gets or sets the musical key in which the sound starts.
This value is represented by the TKEY frame.
length_in_milliseconds Gets or sets the length of the audio file in milliseconds, represented as a numeric string.
This value is represented by the TLEN frame.
original_album Gets or sets the original album/movie/show title.
This value is represented by the TOAL frame.
track_number Gets or sets a numeric string containing the order number of the audio-file on its original recording.
This value is represented by the TRCK frame.
size_in_bytes Gets or sets the size of the audio file in bytes, excluding the ID3v2 tag, represented as a numeric string.
This value is represented by the TSIZ frame.
isrc Gets or sets the International Standard Recording Code (ISRC) (12 characters).
This value is represented by the TSRC frame.
software_hardware Gets or sets the used audio encoder and its settings when the file was encoded.
This value is represented by the TSSE frame.
year Gets or sets a numeric string with a year of the recording. This frames is always four characters long (until the year 10000).
This value is represented by the TYER frame.
comments Gets or sets the user comments.
This value is represented by the COMM frame.
The frame is intended for any kind of full text information that does not fit in any other frame.
attached_pictures Gets or sets the attached pictures directly related to the audio file.
This value is represented by the APIC frame.
track_play_counter Gets the number of times the file has been played.
This value is represented by the PCNT frame.

Methods

Method Description
contains Determines whether the package contains a metadata property with the specified name.
find_properties Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.
update_properties Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.
remove_properties Removes metadata properties satisfying a specification.
add_properties Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
set_properties Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.
sanitize Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.
to_list Creates a list from the package.
remove_attached_pictures Removes all attached pictures stored in APIC frames.
get Gets an array of frames with the specified id.
set Removes all frames having the same id as the specified one and adds the new frame to the tag.
clear Removes all frames with the specified id.
add Adds a frame to the tag.
remove Removes the specified frame from the tag.

Remarks

Learn more | | |

Example

This example shows how to read the ID3v2 tag in an MP3 file.

See Also

ID3V2PrivateFrame class ID3V2TagFrame class