org.farng.mp3.id3
Class FrameBodyTKEY

java.lang.Object
  org.farng.mp3.AbstractMP3FileItem
      org.farng.mp3.AbstractMP3FragmentBody
          org.farng.mp3.id3.AbstractID3v2FrameBody
              org.farng.mp3.id3.AbstractFrameBodyTextInformation
                  org.farng.mp3.id3.FrameBodyTKEY

public class FrameBodyTKEY

extends AbstractFrameBodyTextInformation

The 'Initial key' frame contains the musical key in which the sound
starts. It is represented as a string with a maximum length of three

characters. The ground keys are represented with "A","B","C","D","E",
"F" and "G" and halfkeys represented with "b" and "#". Minor is

represented as "m", e.g. "Dbm" $00. Off key is represented with an
"o" only.

Version:

$Revision: 1.4 $

Author:

Eric Farng

Constructor Summary

FrameBodyTKEY()
Creates a new FrameBodyTKEY object.

FrameBodyTKEY(byte textEncoding, java.lang.String text)
Creates a new FrameBodyTKEY object.

FrameBodyTKEY(FrameBodyTKEY body)
Creates a new FrameBodyTKEY object.

FrameBodyTKEY(java.io.RandomAccessFile file)
Creates a new FrameBodyTKEY object.

Method Summary

java.lang.String

getIdentifier() ID string that usually corresponds to the class name, but can be displayed to the user.

Methods inherited from class org.farng.mp3.id3.AbstractFrameBodyTextInformation

getBriefDescription, getText, getTextEncoding, setText, setTextEncoding, setupObjectList

Methods inherited from class org.farng.mp3.id3.AbstractID3v2FrameBody

equals, readHeader, writeHeader

Methods inherited from class org.farng.mp3.AbstractMP3FragmentBody

appendToObjectList, getDescription, getObject, getObjectListIterator, getSize, has6ByteHeader, isSubsetOf, iterator, read, setObject, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FrameBodyTKEY

public FrameBodyTKEY()

Creates a new FrameBodyTKEY object.

FrameBodyTKEY

public FrameBodyTKEY(FrameBodyTKEY body)

Creates a new FrameBodyTKEY object.

FrameBodyTKEY

public FrameBodyTKEY(byte textEncoding,
                     java.lang.String text)

Creates a new FrameBodyTKEY object.

FrameBodyTKEY

public FrameBodyTKEY(java.io.RandomAccessFile file)
              throws java.io.IOException,
                     InvalidTagException

Creates a new FrameBodyTKEY object.

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Description copied from class: AbstractMP3FileItem

ID string that usually corresponds to the class name, but can be displayed to the user. It is not indended to identify each individual instance.

Specified by:

getIdentifier in class AbstractMP3FileItem

Returns:

ID string