C# Class TagLib.Id3v2.UrlLinkFrame

This class extends Frame to provide support ID3v2 Url Link Frames (Section 4.3.1), covering "W000" to "WZZZ", excluding "WXXX".

With these frames dynamic data such as webpages with touring information, price information or plain ordinary news can be added to the tag. There may only be one URL [URL] link frame of its kind in an tag, except when stated otherwise in the frame description. If the text string is followed by a string termination, all the following information should be ignored and not be displayed.

The following table contains types and descriptions as found in the ID3 2.4.0 native frames specification. (Copyright (C) Martin Nilsson 2000.)

ID Description WCOM The 'Commercial information' frame is a URL pointing at a webpage with information such as where the album can be bought. There may be more than one "WCOM" frame in a tag, but not with the same content. WCOP The 'Copyright/Legal information' frame is a URL pointing at a webpage where the terms of use and ownership of the file is described. WOAF The 'Official audio file webpage' frame is a URL pointing at a file specific webpage. WOAR The 'Official artist/performer webpage' frame is a URL pointing at the artists official webpage. There may be more than one "WOAR" frame in a tag if the audio contains more than one performer, but not with the same content. WOAS The 'Official audio source webpage' frame is a URL pointing at the official webpage for the source of the audio file, e.g. a movie. WORS The 'Official Internet radio station homepage' contains a URL pointing at the homepage of the internet radio station. WPAY The 'Payment' frame is a URL pointing at a webpage that will handle the process of paying for this file. WPUB The 'Publishers official webpage' frame is a URL pointing at the official webpage for the publisher.
Inheritance: TagLib.Id3v2.Frame
显示文件 Open project: mono/taglib-sharp Class Usage Examples

Public Methods

Method Description
Clone ( ) : TagLib.Id3v2.Frame

Creates a deep copy of the current instance.
Get ( Tag tag, ByteVector ident, bool create ) : UrlLinkFrame

Gets a UrlLinkFrame object of a specified type from a specified tag, optionally creating and adding one with a specified encoding if none is found.

To create a frame without having to specify the encoding, use Get(Tag,ByteVector,bool).

Render ( byte version ) : ByteVector

Renders the current instance, encoded in a specified ID3v2 version.
ToString ( ) : string

Gets a string representation of the current instance.
UrlLinkFrame ( ByteVector ident ) : System

Constructs and initializes a new instance of UrlLinkFrame with a specified identifier and text encoding.
UrlLinkFrame ( ByteVector data, byte version ) : System

Constructs and initializes a new instance of UrlLinkFrame by reading its raw contents in a specified ID3v2 version.

Protected Methods

Method Description
ParseFields ( ByteVector data, byte version ) : void

Populates the values in the current instance by parsing its field data in a specified version.
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.

RenderFields ( byte version ) : ByteVector

Renders the values in the current instance into field data for a specified version.
UrlLinkFrame ( ByteVector data, int offset, TagLib.Id3v2.FrameHeader header, byte version ) : System

Constructs and initializes a new instance of UrlLinkFrame by reading its raw contents from a specifed position in a ByteVector object in a specified ID3v2 version.

Method Details

Clone() public method

Creates a deep copy of the current instance.
public Clone ( ) : TagLib.Id3v2.Frame
return TagLib.Id3v2.Frame

Get() public static method

Gets a UrlLinkFrame object of a specified type from a specified tag, optionally creating and adding one with a specified encoding if none is found.
To create a frame without having to specify the encoding, use Get(Tag,ByteVector,bool).
/// or is /// . /// /// is not exactly four bytes long. ///
public static Get ( Tag tag, ByteVector ident, bool create ) : UrlLinkFrame
tag Tag /// A object to search for the specified /// tag in. ///
ident ByteVector /// A object containing the frame /// identifer to search for. ///
create bool /// A value specifying whether or not to /// create a new frame if an existing frame was not found. ///
return UrlLinkFrame

ParseFields() protected method

Populates the values in the current instance by parsing its field data in a specified version.
protected ParseFields ( ByteVector data, byte version ) : void
data ByteVector /// A object containing the /// extracted field data. ///
version byte /// A indicating the ID3v2 version the /// field data is encoded in. ///
return void

ParseRawData() protected method

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.
protected ParseRawData ( ) : void
return void

Render() public method

Renders the current instance, encoded in a specified ID3v2 version.
public Render ( byte version ) : ByteVector
version byte /// A value specifying the version of /// ID3v2 to use when encoding the current instance. ///
return ByteVector

RenderFields() protected method

Renders the values in the current instance into field data for a specified version.
protected RenderFields ( byte version ) : ByteVector
version byte /// A indicating the ID3v2 version the /// field data is to be encoded in. ///
return ByteVector

ToString() public method

Gets a string representation of the current instance.
public ToString ( ) : string
return string

UrlLinkFrame() public method

Constructs and initializes a new instance of UrlLinkFrame with a specified identifier and text encoding.
public UrlLinkFrame ( ByteVector ident ) : System
ident ByteVector /// A object containing an ID3v2.4 /// frame identifier. ///
return System

UrlLinkFrame() public method

Constructs and initializes a new instance of UrlLinkFrame by reading its raw contents in a specified ID3v2 version.
public UrlLinkFrame ( ByteVector data, byte version ) : System
data ByteVector /// A object starting with the /// frame to read. ///
version byte /// A value containing the ID3v2 version /// in which is encoded. ///
return System

UrlLinkFrame() protected method

Constructs and initializes a new instance of UrlLinkFrame by reading its raw contents from a specifed position in a ByteVector object in a specified ID3v2 version.
protected UrlLinkFrame ( ByteVector data, int offset, TagLib.Id3v2.FrameHeader header, byte version ) : System
data ByteVector /// A object containing the frame /// to read. ///
offset int /// A value specifying the offset in /// at which the frame begins. ///
header TagLib.Id3v2.FrameHeader /// A value containing the header /// that would be read in the frame. ///
version byte /// A value containing the ID3v2 version /// in which is encoded. ///
return System