org.jaudiotagger.tag.id3.framebody
Class FrameBodyTKEY

java.lang.Object
  org.jaudiotagger.tag.id3.AbstractTagItem
      org.jaudiotagger.tag.id3.AbstractTagFrameBody
          org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody
              org.jaudiotagger.tag.id3.framebody.AbstractFrameBodyTextInfo
                  org.jaudiotagger.tag.id3.framebody.FrameBodyTKEY

All Implemented Interfaces:

ID3v23FrameBody, ID3v24FrameBody

public class FrameBodyTKEY
extends AbstractFrameBodyTextInfo
implements ID3v24FrameBody, ID3v23FrameBody

Initial key Text information frame.

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". Example "Cbm". Off key is represented with an "o" only.

For more details, please refer to the ID3 specifications:

• ID3 v2.3.0 Spec

Version:

$Id: FrameBodyTKEY.java,v 1.14 2009/11/12 13:25:20 paultaylor Exp $

Author:

: Paul Taylor, : Eric Farng

Field Summary

Fields inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody

TYPE_BODY

Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody

objectList

Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagItem

logger

Constructor Summary

FrameBodyTKEY()
Creates a new FrameBodyTKEY datatype.

FrameBodyTKEY(java.nio.ByteBuffer byteBuffer, int frameSize)
Creates a new FrameBodyTKEY datatype.

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

FrameBodyTKEY(FrameBodyTKEY body)

Method Summary

java.lang.String	getIdentifier() The ID3v2 frame identifier
boolean	isValid()

Methods inherited from class org.jaudiotagger.tag.id3.framebody.AbstractFrameBodyTextInfo

addTextValue, getFirstTextValue, getNumberOfValues, getText, getValueAtIndex, setText, setupObjectList, write

Methods inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody

createStructure, equals, getSize, read, setSize, setSize

Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody

getBriefDescription, getHeader, getLongDescription, getObject, getObjectValue, getTextEncoding, isSubsetOf, iterator, setHeader, setObjectValue, setTextEncoding, toString

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 datatype.

FrameBodyTKEY

public FrameBodyTKEY(FrameBodyTKEY body)

FrameBodyTKEY

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

Creates a new FrameBodyTKEY datatype.

Parameters:

textEncoding -

text -

FrameBodyTKEY

public FrameBodyTKEY(java.nio.ByteBuffer byteBuffer,
                     int frameSize)
              throws InvalidTagException

Creates a new FrameBodyTKEY datatype.

Parameters:

byteBuffer -

frameSize -

Throws:

java.io.IOException

InvalidTagException

Method Detail

getIdentifier

public java.lang.String getIdentifier()

The ID3v2 frame identifier

Specified by:

getIdentifier in class AbstractID3v2FrameBody

Returns:

the ID3v2 frame identifier for this frame type

isValid

public boolean isValid()

Returns:

true if text value is valid musical key notation