 | Frame Class |
Encapsulates a single piece of information in a Tag.
Inheritance HierarchyNamespace: Orthogonal.NTagLite
Assembly: Orthogonal.NTagLite (in Orthogonal.NTagLite.dll) Version: 3.0.4
SyntaxC#
public class Frame
The Frame type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Frame(Byte) | Constructs a Frame from a byte array buffer. |
| Frame(Int32, Byte) | Constructs a Frame from bytes at an offset in an array. |
Properties| Name | Description | |
|---|---|---|
 | Data | Gets or sets the frame's raw data buffer. |
| Description | Gets or sets the description of frames that support a description. Set a null value to remove a description. A exception is thrown in the setter if the frame does not support a description. |
| Enc | Gets the text encoding enumeration of a frame. Null is returned if the frame does not support encoding. |
| Flags1 | Gets or sets the frame's first flag byte. |
| Flags2 | Gets or sets the frame's second flag byte. |
| Id | Gets the 4 character ID of the frame stongly typed as an enum. If this value is null then the frame did not contain a recognisable ID and the RawId property will contain the original string ID that couldn't be parsed. |
| IsCompressed | See ID3 v2.3 section 3.3.1 'i' (Compression flag bit) |
| IsEncrypted | See ID3 v2.3 section 3.3.1 'j' (Encryption flag bit) |
| IsFileAlterPreserve | See ID3 v2.3 section 3.3.1 'b' (File alter preservation flag bit) |
| IsGrouped | See ID3 v2.3 section 3.3.1 'k' (Grouping identity flag bit) |
| IsReadOnly | See ID3 v2.3 section 3.3.1 'c' (Read only flag bit) |
| IsTagAlterPreserve | See ID3 v2.3 section 3.3.1 'a' (Tag alter preservation flag bit) |
| Language | Gets or sets the 3 character ISO 639-2 language code for frames that support a language. Set a null value to remove any language code. A exception is thrown in the setter if the frame does not support language. |
| Offset | Gets the offset into the file where the frame was found. |
| Rating | Gets or sets the rating as a value that is null for no rating, or a value from 1 to 255. The value is converted in ranges into the five star ratings in slightly different ways by different popular tagging applications. |
| RawId | Gets the raw original text string of the frame's ID if the string could not be parsed as an enumeration. |
| SafeId | Gets the Frame's Id as a string. If the source Id was one of the recognised enumerated values then the enumeration value is returned as a string. If the source Id was not recognised then it's original raw string value is returned. This is a convenience property for use in dumping the Frame's Id in a safe manner. |
| Size | Gets or sets the size of the frame's data. |
| SourceTagVersion | Gets the version of the tag that generated the frame, currently only 1 or 2 for parsed frames, null for frames added later. |
| Text | Gets or sets the encoded text of frames that support text. A exception is thrown in the setter if the frame does not support text. The correct encoding (ASCII or 2-byte Unicode) will be chosen automatically based upon the contents of the text value when the tag is saved. |
| TrackCount | Gets or sets the track total number of the TRCK frame. A exception is thrown in the setter if the frame does not have a track number. The track number property must be set before the track count. |
| TrackNumber | Gets or sets the track number of the TRCK frame. A exception is thrown in the setter if the frame does not support a track number. |
| Url | Gets or sets ASCII url text of frames that support a url. A exception is thrown in the setter if the frame does not support a url. |
| Year | Gets or sets the year which is stored as 4 numeric characters. |
Methods| Name | Description | |
|---|---|---|
| GetPicture | Retrieves a strongly typed Picture object from an APIC frame. |
| LoadFromV23Buffer | Loads a Frame instance's complete information from a raw v2.3 frame data buffer. |
 | MakeFrame | Makes a Frame with an ID and raw data. |
| MakeLangTextFrame | Makes a text Frame with an ID, Ascii language and encoded text. Currently only the USER frame has this format and this special case method is required to handle it. |
| MakePopularityFrame | Makes a POPM popularity (rating) Frame. |
| MakeTextFrame(FrameId, String) | Makes a text Frame with an ID and encoded text. Currently all IDs starting with 'T' (excluding TXXX which also has an encoded description). |
| MakeTextFrame(FrameId, String, String) | Makes a text Frame with an ID, encoded description and encoded text. Currently only TXXX has this format. |
| MakeTextFrame(FrameId, NullableIsoLanguage, String, String) | Makes a text Frame with an ID, ascii language, encoding description and full encoded text. Currently only COMM and USLT have this format. |
| MakeTrackFrame | Makes a track Frame with a track number and optional track count. |
| MakeUrlFrame(FrameId, String) | Makes a url Frame with an ID and ASCII url. Currently all W*** frames have this format with the exception of WXXX which includes an encoded description. |
| MakeUrlFrame(FrameId, String, String) | Makes a url Frame with an ID, encoded description and ASCII url. Currently only WXXX has this format. |
| SafeFullText | Normalises a 'full text' multi-line string so that lines are separated by a single $0a as defined in the v2.3 spec. |
| SaveToStream | Writes (serializes) a Frame to a Stream. |
See Also