C# Class TagLib.Id3v2.PopularimeterFrame

This class extends Frame, implementing support for ID3v2 Popularimeter (POPM) Frames.
Inheritance: TagLib.Id3v2.Frame
Show file Open project: MediaPortal/MPTagThat Class Usage Examples

Public Methods

Method Description
Clone ( ) : TagLib.Id3v2.Frame

Creates a deep copy of the current instance.

Get ( Tag tag, string user, bool create ) : PopularimeterFrame

Gets a popularimeter frame from a specified tag, optionally creating it if it does not exist.

PopularimeterFrame ( ByteVector data, byte version ) : System

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

PopularimeterFrame ( string user ) : System

Constructs and initializes a new instance of for a specified user with a rating and play count of zero.

When a frame is created, it is not automatically added to the tag. Consider using Get for more integrated frame creation.

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.

PopularimeterFrame ( ByteVector data, int offset, TagLib.Id3v2.FrameHeader header, byte version ) : System

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

RenderFields ( byte version ) : ByteVector

Renders the values in the current instance into field data for a specified 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 popularimeter frame from a specified tag, optionally creating it if it does not exist.
public static Get ( Tag tag, string user, bool create ) : PopularimeterFrame
tag Tag /// A object to search in. ///
user string /// A containing the user to search for /// in the current instance. ///
create bool /// A specifying whether or not to create /// and add a new frame to the tag if a match is not found. ///
return PopularimeterFrame

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

PopularimeterFrame() public method

Constructs and initializes a new instance of by reading its raw data in a specified ID3v2 version.
public PopularimeterFrame ( ByteVector data, byte version ) : System
data ByteVector /// A object starting with the raw /// representation of the new frame. ///
version byte /// A indicating the ID3v2 version the /// raw frame is encoded in. ///
return System

PopularimeterFrame() protected method

Constructs and initializes a new instance of by reading its raw data in a specified ID3v2 version.
protected PopularimeterFrame ( ByteVector data, int offset, TagLib.Id3v2.FrameHeader header, byte version ) : System
data ByteVector /// A object containing the raw /// representation of the new frame. ///
offset int /// A indicating at what offset in /// the frame actually begins. ///
header TagLib.Id3v2.FrameHeader /// A containing the header of the /// frame found at in the data. ///
version byte /// A indicating the ID3v2 version the /// raw frame is encoded in. ///
return System

PopularimeterFrame() public method

Constructs and initializes a new instance of for a specified user with a rating and play count of zero.
When a frame is created, it is not automatically added to the tag. Consider using Get for more integrated frame creation.
public PopularimeterFrame ( string user ) : System
user string
return System

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