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

FrameBodyPRIV

public class FrameBodyPRIV extends AbstractID3v2FrameBody implements ID3v24FrameBody, ID3v23FrameBody
Private frame.

This frame is used to contain information from a software producer that its program uses and does not fit into the other frames. The frame consists of an 'Owner identifier' string and the binary data. The 'Owner identifier' is a null-terminated string with a URL containing an email address, or a link to a location where an email address can be found, that belongs to the organisation responsible for the frame. Questions regarding the frame should be sent to the indicated email address. The tag may contain more than one "PRIV" frame but only with different contents. It is recommended to keep the number of "PRIV" frames as low as possible.

<Header for 'Private frame', ID: "PRIV">
Owner identifier<text string> $00
The private data<binary data>

For more details, please refer to the ID3 specifications:

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

Fields Summary
Constructors Summary
public FrameBodyPRIV()
Creates a new FrameBodyPRIV datatype.

        this.setObjectValue(DataTypes.OBJ_OWNER, "");
        this.setObjectValue(DataTypes.OBJ_DATA, new byte[0]);
public FrameBodyPRIV(FrameBodyPRIV body)

        super(body);
public FrameBodyPRIV(String owner, byte[] data)
Creates a new FrameBodyPRIV datatype.

param
owner
param
data

        this.setObjectValue(DataTypes.OBJ_OWNER, owner);
        this.setObjectValue(DataTypes.OBJ_DATA, data);
public FrameBodyPRIV(ByteBuffer byteBuffer, int frameSize)
Creates a new FrameBodyPRIV datatype.

param
byteBuffer
param
frameSize
throws
InvalidTagException if unable to create framebody from buffer

        super(byteBuffer, frameSize);
Methods Summary
public byte[]getData()

return

        return (byte[]) getObjectValue(DataTypes.OBJ_DATA);
public java.lang.StringgetIdentifier()
The ID3v2 frame identifier

return
the ID3v2 frame identifier for this frame type

        return ID3v24Frames.FRAME_ID_PRIVATE;
public java.lang.StringgetOwner()

return

        return (String) getObjectValue(DataTypes.OBJ_OWNER);
public voidsetData(byte[] data)

param
data

        setObjectValue(DataTypes.OBJ_DATA, data);
public voidsetOwner(java.lang.String owner)

param
owner

        setObjectValue(DataTypes.OBJ_OWNER, owner);
protected voidsetupObjectList()

        objectList.add(new StringNullTerminated(DataTypes.OBJ_OWNER, this));
        objectList.add(new ByteArraySizeTerminated(DataTypes.OBJ_DATA, this));