FileDocCategorySizeDatePackage
FrameBodyTKEY.javaAPI DocJaudiotagger 2.0.43103Wed Mar 30 16:12:02 BST 2011org.jaudiotagger.tag.id3.framebody

FrameBodyTKEY

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:

author
: Paul Taylor
author
: Eric Farng
version
$Id: FrameBodyTKEY.java 832 2009-11-12 13:25:38Z paultaylor $

Fields Summary
Constructors Summary
public FrameBodyTKEY()
Creates a new FrameBodyTKEY datatype.
public FrameBodyTKEY(FrameBodyTKEY body)

        super(body);
public FrameBodyTKEY(byte textEncoding, String text)
Creates a new FrameBodyTKEY datatype.

param
textEncoding
param
text

        super(textEncoding, text);
public FrameBodyTKEY(ByteBuffer byteBuffer, int frameSize)
Creates a new FrameBodyTKEY datatype.

param
byteBuffer
param
frameSize
throws
java.io.IOException
throws
InvalidTagException

        super(byteBuffer, frameSize);
Methods Summary
public java.lang.StringgetIdentifier()
The ID3v2 frame identifier

return
the ID3v2 frame identifier for this frame type

        return ID3v24Frames.FRAME_ID_INITIAL_KEY;
public booleanisValid()

return
true if text value is valid musical key notation

        return MusicalKey.isValid(getFirstTextValue());