 | Tag Class |
Encapsulates all v2.x and v1.x tag and frame information parsed from a file.
Inheritance HierarchyNamespace: Orthogonal.NTagLite
Assembly: Orthogonal.NTagLite (in Orthogonal.NTagLite.dll) Version: 3.0.4
SyntaxC#
public class Tag
The Tag type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Album | Convenience property: Gets or sets the Album in a TALB frame. |
| Artist | Convenience property: Gets or sets the Artist in a TPE1 frame. |
| ArtistWebPage | Convenience property: Gets or sets the ArtistWebPage in a WOAR frame. |
| Band | Convenience property: Gets or sets the Band in a TPE2 frame. |
| Comment | Convenience property: Gets or sets the Comment in a COMM frame. |
| Composer | Convenience property: Gets or sets the Composer in a TCOM frame. |
| Conductor | Convenience property: Gets or sets the Conductor in a TPE3 frame. |
| Copyright | Convenience property: Gets or sets the Copyright in a TCOP frame. |
| CopyrightWebPage | Convenience property: Gets or sets the CopyrightWebPage in a WCOP frame. |
| EncodedBy | Convenience property: Gets or sets the EncodedBy in a TENC frame. |
| Flags | Gets the flags byte in the ID3 tag header. |
| FrameCount | Gets the total number of frames in the tag. |
| Frames | Gets a read only collection of all frames in the tag. |
| Genre | Convenience property: Gets or sets the Genre in a TCON frame. |
| HasExtendedHeader | See ID3 v2.3 section 3.1 'b' (Extended header flag bit) |
| HasFooter | See ID3 v2.4 section 3.1 'd' (footer present flag bit) |
| Id | Gets the string identifier of the ID3 tag header (expected to be 'ID3'). |
| IsCompressed | See ID3 v2.2 section 3.1 'a' (compression flag bit) |
| IsExperimental | See ID3 v2.3 and v2.4 section 3.1 'c' (Experimental flag bit) |
| IsUnsynchronised | See ID3 v2.2, v2.3 and v2.4 section 3.1 'a' (Unsynchronisation flag bit) |
| Lyricist | Convenience property: Gets or sets the Lyricist in a TEXT frame. |
| MajorVersion | Gets the first version number in the ID3 tagheader (only 2, 3 and 4 are supported). |
| Media | Convenience property: Gets or sets the Media in a TMED frame. |
| MinorVersion | Gets the second version number in the ID3 tag header (the library ignores this value). |
| OriginalArtist | Convenience property: Gets or sets the OriginalArtist in a TOPE frame. |
| OriginalLyricist | Convenience property: Gets or sets the OriginalLyricist in a TOLY frame. |
| OriginalTitle | Convenience property: Gets or sets the OriginalTitle in a TOAL frame. |
| OtherWebPage | Convenience property: Gets or sets the OtherWebPage in a WXXX frame. |
| Owner | Convenience property: Gets or sets the Owner in a TOWN frame. |
| Publisher | Convenience property: Gets or sets the Publisher in a TPUB frame. |
| Rating | Convenience property: Gets or sets the rating as a value from 0-255. |
| RawSizeBytes | Gets the raw synchsafe bytes specifying the ID3 tag size. |
| Size | Gets the size of the ID3 after decoding the raw synchsafe size bytes. The size includes all frames and padding. |
| TextFrames | Gets an enumerable set of all text frames in the tag. |
| TextOrUrlFrames | Gets an enumerable set of all text or url frames in the tag. |
| Title | Convenience property: Gets or sets the Title in a TIT2 frame. |
| TrackCount | Convenience property: Gets or sets the track count in a TRCK frame. |
| TrackNumber | Convenience property: Gets or sets the track number in a TRCK frame. |
| UnsynchedLyrics | Convenience property: Gets or sets the UnsynchedLyrics in a USLT frame. |
| UrlFrames | Gets an enumerable set of all url frames in the tag. |
| UserText | Convenience property: Gets or sets the UserText in a TXXX frame. |
| V1Offset | Gets the offset into the file where the V1 tag was found. |
| V1TagFound | Gets a flag indicating if a V1 tag was found at the end of the file. |
| V2TagFound | Gets a flag indicating if a V2 tag was found at the start of the file. |
| Year | Convenience property: Gets or sets the year in a TYER frame. |
Methods| Name | Description | |
|---|---|---|
 | AddFrame(Frame) | Adds a frame to the tag, safely avoiding invalid duplicates. If the frame being added is contrained so that only one with the ID is allowed in a tag, then any previous frames of the same ID are removed before the new one is added. |
| AddFrame(FrameId, Byte) | Safely adds an arbitrary frame constructed from an ID and raw data. |
| AddLangTextFrame | Safely adds a text frame constructed by an ID, a language and text. |
| AddPictureFrame(LitePictureType, String, String) | Safely adds a picture frame constructed by a type, a description and a file name that will be read to provide the picture data buffer. |
| AddPictureFrame(LitePictureType, String, String, Byte) | Safely adds a picture frame constructed by a type, a description and a picture data buffer. |
| AddTextFrame(FrameId, String) | Safely adds a text frame constructed by an ID and text. |
| AddTextFrame(FrameId, String, String) | Safely adds a text frame constructed by an ID, a description and text. |
| AddTextFrame(FrameId, NullableIsoLanguage, String, String) | Safely adds a text frame constructed by an ID, a language, a description and text. |
| AddTrackFrame | Safely adds a track frame constructed by a track number and optional track count. |
| AddUrlFrame(FrameId, String) | Safely adds a url frame constructed by an ID and a Latin ISO encoded url. |
| AddUrlFrame(FrameId, String, String) | Safely adds a url frame constructed by an ID, a description and a Latin ISO encoded url. |
| AddYearFrame | Safely adds a year frame. |
| FindFirstFrameById | Finds the first frame with a specified Frame ID. Returns null if no frame is found. |
| FindFramesById | Finds all frames with a specified Frame ID. The returned array may be zero length, not null. |
| MergeV1Tag | Information from the V1 tag is added to the frame collection if frames with the same information type do not already exist. |
| RemoveAll | Removes all frames from the Tag. |
| RemoveAllFramesById | Removes all frames of a specified ID. |
| RemoveFirstFrameById | Safely removes a frame of a specified ID if one exists. If there are multiples of the same ID then the first one found is removed. |
| RemoveFrame | Removes a specific frame from the frames. |
| SaveToBuffer | Writes (serializes) the Tag to a byte array. |
| SaveToStream | Writes (serializes) a Tag and its frames to a stream. The Stream to write the tag to.The caller tells us the desired size of the tag. If the tag takes less space than this value then padding zero-filled bytes are appended to make the desired size. |
| SortFrames | Sorts the frames using a comparison rule determined by the caller. |
| V1ToStream | A V1 tag is written to the stream with fields completed if they have corresponding Frames. |
See Also