C# Class TagLib.Id3v2.UserTextInformationFrame

This class extends TextInformationFrame to provide support for ID3v2 User Text Information (TXXX) Frames.
Inheritance: TextInformationFrame
Exibir arquivo Open project: mono/taglib-sharp Class Usage Examples

Public Methods

Method Description
Get ( Tag tag, string description, StringType type, bool create ) : UserTextInformationFrame

Gets a specified user text frame from the specified tag, optionally creating it if it does not exist.
Get ( Tag tag, string description, StringType type, bool create, bool caseSensitive ) : UserTextInformationFrame

Gets a specified user text frame from the specified tag, optionally creating it if it does not exist and optionally searching for the frame case-insensitive.
Get ( Tag tag, string description, bool create ) : UserTextInformationFrame

Gets a specified user text frame from the specified tag, optionally creating it if it does not exist.
ToString ( ) : string

Gets a string representation of the current instance.
UserTextInformationFrame ( ByteVector data, byte version ) : System

Constructs and initializes a new instance of by reading its raw data in a specified ID3v2 version.
UserTextInformationFrame ( string description ) : System

Constructs and initializes a new instance of with a specified description.

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

UserTextInformationFrame ( string description, StringType encoding ) : System

Constructs and initializes a new instance of with a specified description and text encoding.

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

Protected Methods

Method Description
UserTextInformationFrame ( 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.

Private Methods

Method Description
Get ( Tag tag, string description ) : UserTextInformationFrame

Method Details

Get() public static method

Gets a specified user text frame from the specified tag, optionally creating it if it does not exist.
public static Get ( Tag tag, string description, StringType type, bool create ) : UserTextInformationFrame
tag Tag /// A object to search in. ///
description string /// A specifying the description to /// match. ///
type StringType /// A specifying the encoding to /// use if creating a new frame. ///
create bool /// A specifying whether or not to create /// and add a new frame to the tag if a match is not found. ///
return UserTextInformationFrame

Get() public static method

Gets a specified user text frame from the specified tag, optionally creating it if it does not exist and optionally searching for the frame case-insensitive.
public static Get ( Tag tag, string description, StringType type, bool create, bool caseSensitive ) : UserTextInformationFrame
tag Tag /// A object to search in. ///
description string /// A specifying the description to /// match. ///
type StringType /// A specifying the encoding to /// use if creating a new frame. ///
create bool /// A specifying whether or not to create /// and add a new frame to the tag if a match is not found. ///
caseSensitive bool /// A specifying whether or not to search /// for the frame case-sensitive. ///
return UserTextInformationFrame

Get() public static method

Gets a specified user text frame from the specified tag, optionally creating it if it does not exist.
public static Get ( Tag tag, string description, bool create ) : UserTextInformationFrame
tag Tag /// A object to search in. ///
description string /// A specifying the description to /// match. ///
create bool /// A specifying whether or not to create /// and add a new frame to the tag if a match is not found. ///
return UserTextInformationFrame

ToString() public method

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

UserTextInformationFrame() public method

Constructs and initializes a new instance of by reading its raw data in a specified ID3v2 version.
public UserTextInformationFrame ( 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

UserTextInformationFrame() protected method

Constructs and initializes a new instance of by reading its raw data in a specified ID3v2 version.
protected UserTextInformationFrame ( 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

UserTextInformationFrame() public method

Constructs and initializes a new instance of with a specified description.
When a frame is created, it is not automatically added to the tag. Consider using for more integrated frame creation.
public UserTextInformationFrame ( string description ) : System
description string /// A containing the description of the /// new frame. ///
return System

UserTextInformationFrame() public method

Constructs and initializes a new instance of with a specified description and text encoding.
When a frame is created, it is not automatically added to the tag. Consider using for more integrated frame creation.
public UserTextInformationFrame ( string description, StringType encoding ) : System
description string /// A containing the description of the /// new frame. ///
encoding StringType /// A containing the text encoding /// to use when rendering the new frame. ///
return System