org.blinkenlights.jid3.v2
Class POSSID3V2Frame

java.lang.Object
  org.blinkenlights.jid3.v2.ID3V2Frame
      org.blinkenlights.jid3.v2.POSSID3V2Frame

All Implemented Interfaces:

ID3Subject, ID3Visitable

public class POSSID3V2Frame

extends ID3V2Frame

Frame containing position synchronization information.

Nested Class Summary

static class

POSSID3V2Frame.TimestampFormat Timestamp format.

Constructor Summary

POSSID3V2Frame(java.io.InputStream oIS)

POSSID3V2Frame(POSSID3V2Frame.TimestampFormat oTimestampFormat, int iPosition)
Creates a new instance of POSSID3V2Frame.

Method Summary

void	accept(ID3Visitor oID3Visitor) Accept a visitor.
boolean	equals(java.lang.Object oOther)
protected byte[]	getFrameId() Get the four bytes which uniquely specify of which type this frame is.
int	getPosition() Get the position of the start of this track.
POSSID3V2Frame.TimestampFormat	getTimestampFormat() Get the timestamp format.
void	setPositionSynchronizationValue(POSSID3V2Frame.TimestampFormat oTimestampFormat, int iPosition) Set position synchronization values for this frame.
java.lang.String	toString() Represent the contents of this frame as a string.
protected void	writeBody(ID3DataOutputStream oIDOS) Write the body of the frame to an ID3 data output stream.

Methods inherited from class org.blinkenlights.jid3.v2.ID3V2Frame

addID3Observer, getEncryptionMethod, isEncrypted, notifyID3Observers, removeID3Observer, setCompressionFlag, setEncryption, setFileAlterPreservationFlag, setGroupingIdentityFlag, setReadOnlyFlag, setTagAlterPreservationFlag, write, writeHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

POSSID3V2Frame

public POSSID3V2Frame(POSSID3V2Frame.TimestampFormat oTimestampFormat,
                      int iPosition)
               throws ID3Exception

Creates a new instance of POSSID3V2Frame.

Parameters:

oTimestampFormat - the format for timestamps, whether by millisecond or frame count

iPosition - the position in the full recording/broadcast, of the first frame in this stream

Throws:

ID3Exception - if oTimestampFormat is null, or if the position value is negative

POSSID3V2Frame

public POSSID3V2Frame(java.io.InputStream oIS)
               throws ID3Exception

Method Detail

accept

public void accept(ID3Visitor oID3Visitor)

Description copied from interface: ID3Visitable

Accept a visitor.

Parameters:

oID3Visitor - a visitor of this object

setPositionSynchronizationValue

public void setPositionSynchronizationValue(POSSID3V2Frame.TimestampFormat oTimestampFormat,
                                            int iPosition)
                                     throws ID3Exception

Set position synchronization values for this frame.

Parameters:

oTimestampFormat - the format for timestamps, whether by millisecond or frame count

iPosition - the position in the full recording/broadcast, of the first frame in this stream

Throws:

ID3Exception - if oTimestampFormat is null, or if the position value is negative

getTimestampFormat

public POSSID3V2Frame.TimestampFormat getTimestampFormat()

Get the timestamp format.

Returns:

the timestamp format

getPosition

public int getPosition()

Get the position of the start of this track.

Returns:

the position in the specified format, of the start of this track

getFrameId

protected byte[] getFrameId()

Description copied from class: ID3V2Frame

Get the four bytes which uniquely specify of which type this frame is.

Specified by:

getFrameId in class ID3V2Frame

toString

public java.lang.String toString()

Description copied from class: ID3V2Frame

Represent the contents of this frame as a string. For debugging purposes.

Specified by:

toString in class ID3V2Frame

Returns:

a string representing this frame

writeBody

protected void writeBody(ID3DataOutputStream oIDOS)
                  throws java.io.IOException

Description copied from class: ID3V2Frame

Write the body of the frame to an ID3 data output stream.

Specified by:

writeBody in class ID3V2Frame

Parameters:

oIDOS - the output stream to write to

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object oOther)