public class ID3v23FrameBodyEventTimingCodes extends ID3v23FrameBody
An event timing codes frame body is associated with an ID3v2.3 ETCO
frame
which is used to synchronize key events in a song.
The event timing codes frame body contains the following fields:
Field | Description | |
---|---|---|
1. | time stamp format | units of the time stamp field in the event codes field. |
2. | eventCodes | list of events . |
There may be only one event timing codes frame in an ID3v2.3 tag
.
buffer, dirty, frameType
nextNullTerminatorIndex, nullTerminatorIndex
Constructor and Description |
---|
ID3v23FrameBodyEventTimingCodes()
The default constructor is called when creating a new frame.
|
ID3v23FrameBodyEventTimingCodes(java.io.InputStream inputStream,
int frameBodySize)
This constructor is called when reading in an existing frame from an .mp3 file.
|
ID3v23FrameBodyEventTimingCodes(TimeStampFormat timeStampFormat,
java.util.List<EventCode> eventCodes)
This constructor is called when creating a new frame.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<EventCode> |
getEventCodes()
gets the list of events and the time when they occurred in the .mp3 song.
|
TimeStampFormat |
getTimeStampFormat()
get the time stamp format.
|
void |
parse()
parses the raw bytes of the frame body and stores the parsed values in the frame's fields.
|
void |
setBuffer()
If the frame body's values have been modified, then resize the raw binary buffer and store the new values there.
|
void |
setEventCodes(java.util.List<EventCode> eventCodes)
sets the list of events and the time when they occurred in the .mp3 song.
|
void |
setTimeStampFormat(TimeStampFormat timeStampFormat)
sets the time stamp format.
|
java.lang.String |
toString()
gets a string representation of the event timing codes frame body showing all of the frame's fields and their values.
|
getFrameType, getNextNullTerminator, getSize, isDirty, save, save
getNextNullTerminator, pricesToString, stringToBytes
bytesToInt, bytesToInt, bytesToShort, bytesToShort, bytesToSynchsafeInt, bytesToSynchsafeShort, formateDate, hex, hex, hex, intToBytes, littleEndianBytesToInt, pad, shortToBytes, synchsafeIntToBytes
public ID3v23FrameBodyEventTimingCodes()
public ID3v23FrameBodyEventTimingCodes(TimeStampFormat timeStampFormat, java.util.List<EventCode> eventCodes)
timeStampFormat
- units of the time stamp.eventCodes
- list of event codes.public ID3v23FrameBodyEventTimingCodes(java.io.InputStream inputStream, int frameBodySize) throws java.io.IOException
inputStream
- input stream pointing to an event timing codes frame body in the .mp3 file.frameBodySize
- size (in bytes) of the frame's body.java.io.IOException
- if there is an error while reading the frame body.public void parse() throws java.lang.IllegalArgumentException
parse
in class ID3v23FrameBody
java.lang.IllegalArgumentException
- if an invalid value is detected while parsing the frame body's raw bytes.public TimeStampFormat getTimeStampFormat()
setTimeStampFormat(TimeStampFormat)
public void setTimeStampFormat(TimeStampFormat timeStampFormat)
timeStampFormat
- the units of the time stamp.getTimeStampFormat()
public java.util.List<EventCode> getEventCodes()
setEventCodes(List)
public void setEventCodes(java.util.List<EventCode> eventCodes)
eventCodes
- list of events and the time when they occurred in the .mp3 song.getEventCodes()
public void setBuffer()
setBuffer
in class ID3v23FrameBody
public java.lang.String toString()
toString
in class java.lang.Object