|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.blinkenlights.jid3.v2.ID3V2Frame
org.blinkenlights.jid3.v2.SYLTID3V2Frame
Frame containing synchronized lyrics/text.
Nested Class Summary | |
static class |
SYLTID3V2Frame.ContentType
Content type. |
static class |
SYLTID3V2Frame.SyncEntry
SyncEntry class. |
static class |
SYLTID3V2Frame.TimestampFormat
Timestamp format. |
Constructor Summary | |
SYLTID3V2Frame(java.io.InputStream oIS)
|
|
SYLTID3V2Frame(java.lang.String sLanguage,
SYLTID3V2Frame.TimestampFormat oTimestampFormat,
SYLTID3V2Frame.ContentType oContentType,
java.lang.String sContentDescriptor)
Creates a new instance of SYLTID3V2Frame. |
Method Summary | |
void |
accept(ID3Visitor oID3Visitor)
Accept a visitor. |
void |
addSyncEntry(SYLTID3V2Frame.SyncEntry oSyncEntry)
Add a sync entry to the frame. |
boolean |
equals(java.lang.Object oOther)
|
java.lang.String |
getContentDescriptor()
Get the content descriptor for this frame. |
SYLTID3V2Frame.ContentType |
getContentType()
Get the content type. |
protected byte[] |
getFrameId()
Get the four bytes which uniquely specify of which type this frame is. |
java.lang.String |
getLanguage()
Get the language used in this frame. |
SYLTID3V2Frame.SyncEntry |
getSyncEntry(int iTimestamp)
Get a sync entry from this frame. |
TextEncoding |
getTextEncoding()
Get the text encoding used for the content descriptor and text in this frame. |
SYLTID3V2Frame.TimestampFormat |
getTimestampFormat()
Get the timestamp format used. |
int[] |
getTimestamps()
Get all timestamps for which entries have been set in this frame. |
SYLTID3V2Frame.SyncEntry |
removeSyncEntry(int iTimestamp)
Remove a sync entry from this frame. |
void |
setContentDescriptor(java.lang.String sContentDescriptor)
Set the content descriptor for this frame. |
void |
setContentType(SYLTID3V2Frame.ContentType oContentType)
Set the content type. |
void |
setLanguage(java.lang.String sLanguage)
Set the language used in this frame. |
void |
setTextEncoding(TextEncoding oTextEncoding)
Set the text encoding to be used for the content descriptor and text in this frame. |
void |
setTimestampFormat(SYLTID3V2Frame.TimestampFormat oTimestampFormat)
Set the timestamp format used. |
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 |
public SYLTID3V2Frame(java.lang.String sLanguage, SYLTID3V2Frame.TimestampFormat oTimestampFormat, SYLTID3V2Frame.ContentType oContentType, java.lang.String sContentDescriptor) throws ID3Exception
sLanguage
- three letter language code for the content descriptoroTimestampFormat
- the timestamp format used in this frameoContentType
- the content for which synchronization is setsContentDescriptor
- a unique text description for the synchronization details
ID3Exception
- if language is not three characters, or if oTimestampFormat, oContentType or sContentDescriptor are nullpublic SYLTID3V2Frame(java.io.InputStream oIS) throws ID3Exception
Method Detail |
public void accept(ID3Visitor oID3Visitor)
ID3Visitable
oID3Visitor
- a visitor of this objectpublic void setTextEncoding(TextEncoding oTextEncoding)
oTextEncoding
- the text encoding to be used for this framepublic TextEncoding getTextEncoding()
public void setLanguage(java.lang.String sLanguage) throws ID3Exception
sLanguage
- a three letter language code
ID3Exception
- if the language is null or not three characters in length or if this frame is in a tag which
contains another SYLT frame with the same language and content descriptor
ID3Exception
- if this frame is in a tag with another SYLT frame which would have the same language and content descriptorpublic java.lang.String getLanguage()
public void setTimestampFormat(SYLTID3V2Frame.TimestampFormat oTimestampFormat)
oTimestampFormat
- the timestamp format used in this framepublic SYLTID3V2Frame.TimestampFormat getTimestampFormat()
public void setContentType(SYLTID3V2Frame.ContentType oContentType)
oContentType
- the content type for this framepublic SYLTID3V2Frame.ContentType getContentType()
public void setContentDescriptor(java.lang.String sContentDescriptor) throws ID3Exception
sContentDescriptor
- the content descriptor for this frame
ID3Exception
- if the content descriptor is null
ID3Exception
- if this frame is in a tag with another SYLT frame which would have the same language and content descriptorpublic java.lang.String getContentDescriptor()
public void addSyncEntry(SYLTID3V2Frame.SyncEntry oSyncEntry) throws ID3Exception
oSyncEntry
- the sync entry to be added to this frame
ID3Exception
- if oSyncEntry is null, or if a sync entry for this timestamp already exists in this framepublic SYLTID3V2Frame.SyncEntry getSyncEntry(int iTimestamp)
iTimestamp
- the timestamp for which the sync entry should be returned
public SYLTID3V2Frame.SyncEntry removeSyncEntry(int iTimestamp)
iTimestamp
- the timestamp for which the sync entry is to be removed
public int[] getTimestamps()
protected byte[] getFrameId()
ID3V2Frame
getFrameId
in class ID3V2Frame
public java.lang.String toString()
ID3V2Frame
toString
in class ID3V2Frame
protected void writeBody(ID3DataOutputStream oIDOS) throws java.io.IOException
ID3V2Frame
writeBody
in class ID3V2Frame
oIDOS
- the output stream to write to
java.io.IOException
public boolean equals(java.lang.Object oOther)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |