C# Class TagLib.Id3v2.RelativeVolumeFrame

Inheritance: TagLib.Id3v2.Frame
Show file Open project: anyoun/metageta Class Usage Examples

Public Methods

Method Description
Clone ( ) : TagLib.Id3v2.Frame

Creates a deep copy of the current instance.
Get ( Tag tag, string identification, bool create ) : RelativeVolumeFrame

Gets a specified volume adjustment frame from the specified tag, optionally creating it if it does not exist.
GetPeakVolume ( ChannelType type ) : double

Gets the peak volume for a specified channel.
GetPeakVolumeIndex ( ChannelType type ) : ulong

Gets the peak volume index for a specified channel.

The peak volume index is simply the peak volume multiplied by 512.

GetVolumeAdjustment ( ChannelType type ) : float

Gets the volume adjustment for a specified channel.

The value can be between -64dB and +64dB.

GetVolumeAdjustmentIndex ( ChannelType type ) : short

Gets the volume adjustment index for a specified channel.

The volume adjustment index is simply the volume adjustment multiplied by 512.

RelativeVolumeFrame ( ByteVector data, byte version ) : System

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

Constructs and initializes a new instance of with a specified identifier.
SetPeakVolume ( ChannelType type, double peak ) : void

Sets the peak volume for a specified channel.
SetPeakVolumeIndex ( ChannelType type, ulong index ) : void

Sets the peak volume index for a specified channel.

The peak volume index is simply the peak volume multiplied by 512.

SetVolumeAdjustment ( ChannelType type, float adjustment ) : void

Sets the volume adjustment for a specified channel.

The value can be between -64dB and +64dB.

SetVolumeAdjustmentIndex ( ChannelType type, short index ) : void

Sets the volume adjustment index for a specified channel.
ToString ( ) : string

Creates a text description of the current instance.

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.
RelativeVolumeFrame ( 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.

Private Methods

Method Description
BitsToBytes ( int i ) : int

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 specified volume adjustment frame from the specified tag, optionally creating it if it does not exist.
public static Get ( Tag tag, string identification, bool create ) : RelativeVolumeFrame
tag TagLib.Tag /// A object to search in. ///
identification string /// A specifying the identification 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 RelativeVolumeFrame

GetPeakVolume() public method

Gets the peak volume for a specified channel.
public GetPeakVolume ( ChannelType type ) : double
type ChannelType /// A value specifying which /// channel to get the value for. ///
return double

GetPeakVolumeIndex() public method

Gets the peak volume index for a specified channel.
The peak volume index is simply the peak volume multiplied by 512.
public GetPeakVolumeIndex ( ChannelType type ) : ulong
type ChannelType /// A value specifying which /// channel to get the value for. ///
return ulong

GetVolumeAdjustment() public method

Gets the volume adjustment for a specified channel.
The value can be between -64dB and +64dB.
public GetVolumeAdjustment ( ChannelType type ) : float
type ChannelType /// A value specifying which /// channel to get the value for. ///
return float

GetVolumeAdjustmentIndex() public method

Gets the volume adjustment index for a specified channel.
The volume adjustment index is simply the volume adjustment multiplied by 512.
public GetVolumeAdjustmentIndex ( ChannelType type ) : short
type ChannelType /// A value specifying which /// channel to get the value for. ///
return short

ParseFields() protected method

Populates the values in the current instance by parsing its field data in a specified version.
/// contains less than 5 bytes. ///
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

RelativeVolumeFrame() public method

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

RelativeVolumeFrame() protected method

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

RelativeVolumeFrame() public method

Constructs and initializes a new instance of with a specified identifier.
public RelativeVolumeFrame ( string identification ) : System
identification string /// A object containing the /// identification to use for the new frame. ///
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

SetPeakVolume() public method

Sets the peak volume for a specified channel.
public SetPeakVolume ( ChannelType type, double peak ) : void
type ChannelType /// A value specifying which /// channel to set the value for. ///
peak double /// A value containing the peak volume. ///
return void

SetPeakVolumeIndex() public method

Sets the peak volume index for a specified channel.
The peak volume index is simply the peak volume multiplied by 512.
public SetPeakVolumeIndex ( ChannelType type, ulong index ) : void
type ChannelType /// A value specifying which /// channel to set the value for. ///
index ulong /// A value containing the peak volume /// index. ///
return void

SetVolumeAdjustment() public method

Sets the volume adjustment for a specified channel.
The value can be between -64dB and +64dB.
public SetVolumeAdjustment ( ChannelType type, float adjustment ) : void
type ChannelType /// A value specifying which /// channel to set the value for. ///
adjustment float /// A value containing the volume /// adjustment in decibles. ///
return void

SetVolumeAdjustmentIndex() public method

Sets the volume adjustment index for a specified channel.
public SetVolumeAdjustmentIndex ( ChannelType type, short index ) : void
type ChannelType /// A value specifying which /// channel to set the value for. ///
index short /// A value containing the volume /// adjustment index. ///
return void

ToString() public method

Creates a text description of the current instance.
public ToString ( ) : string
return string