public class MP3BaseID3v23
extends java.lang.Object
This base class provides some underlying methods for working with an ID3v2.3 tag.
MP3BaseID3v24
Modifier and Type | Field and Description |
---|---|
protected ID3v23Tag |
id3v23Tag
ID3v2.3 tag which holds all the information about an .mp3 file
|
Constructor and Description |
---|
MP3BaseID3v23() |
Modifier and Type | Method and Description |
---|---|
ID3v23Frame |
addV23Frame(FrameType frameType)
add an ID3v2.3 frame of the specified type to the ID3v2.3 tag.
|
ID3v23Tag |
getID3v23Tag()
gets the ID3v2.3 Tag.
|
protected java.lang.String |
getV23Album()
finds the ID3v2.3
FrameType.ALBUM_TITLE text frame in the ID3v2.3 tag and retrieves the text field. |
protected AttachedPicture |
getV23AttachedPicture(PictureType pictureType)
finds the ID3v2.3
FrameType.ATTACHED_PICTURE frame in the ID3v2.3 tag and retrieves the attached picture. |
protected ID3v23Frame |
getV23AttachedPictureFrame(PictureType pictureType)
finds the ID3v2.3 attached picture frame containing the specified picture type in the ID3v2.3 tag.
|
protected java.util.List<AttachedPicture> |
getV23AttachedPictures()
finds all the ID3v2.3
FrameType.ATTACHED_PICTURE frames in the ID3v2.3 tag and retrieves the attached picture for each frame. |
int |
getV23AudioDuration()
finds the ID3v2.3
FrameType.LENGTH text frame in the ID3v2.3 tag and retrieves the text field. |
protected int |
getV23AudioSize()
finds the ID3v2.3
FrameType.SIZE text frame in the ID3v2.3 tag and retrieves the text field. |
protected java.lang.String |
getV23Band()
finds the ID3v2.3
FrameType.BAND text frame in the ID3v2.3 tag and retrieves the text field. |
protected java.lang.String |
getV23Comments(Language language)
finds the song comments written in the specified language in the ID3v2.3 tag.
|
protected ID3v23Frame |
getV23CommentsFrame(Language language)
finds the ID3v2.3 comments frame with the specified language in the ID3v2.3 tag.
|
java.util.List<java.lang.String> |
getV23Errors()
gets a list of any frame errors encountered while reading in the ID3v2.3 tag.
|
ID3v23Frame |
getV23Frame(FrameType frameType)
finds the first ID3v2.3 frame in the ID3v2.3 tag with the specified ID3v2.3 frame id.
|
java.util.List<ID3v23Frame> |
getV23Frames(FrameType frameType)
finds all the ID3v2.3 frames in the ID3v2.3 tag with the specified ID3v2.3 frame id.
|
protected java.lang.String |
getV23LeadPerformer() |
protected java.lang.String |
getV23LyricsBy()
finds the ID3v2.3
FrameType.LYRICIST text frame in the ID3v2.3 tag and retrieves the text field. |
protected java.lang.String |
getV23MusicBy()
finds the ID3v2.3
FrameType.COMPOSER text frame in the ID3v2.3 tag and retrieves the text field. |
protected java.lang.String |
getV23MusicType()
finds the ID3v2.3
FrameType.CONTENT_TYPE text frame in the ID3v2.3 tag and retrieves the text field. |
protected java.lang.String |
getV23Publisher()
finds the ID3v2.3
FrameType.PUBLISHER text frame in the ID3v2.3 tag and retrieves the text field. |
protected int |
getV23Rating()
finds the ID3v2.3
FrameType.POPULARIMETER frame in the ID3v2.3 tag and retrieves the rating field. |
protected java.util.List<SynchronizedLyric> |
getV23SynchronizedLyrics(Language language)
finds the synchronized song lyrics in the specified language in the ID3v2.3 tag.
|
protected ID3v23Frame |
getV23SynchronizedLyricsFrame(Language language)
finds the ID3v2.3 synchronized lyrics frame containing in the specified language in the ID3v2.3 tag.
|
protected java.lang.String |
getV23Text(FrameType frameType)
finds the ID3v2.3 text frame with the specified ID3v2.3 frame type in the ID3v2.3 tag and retrieves the text field from the ID3v2.3 frame.
|
protected int |
getV23TextAsInteger(FrameType frameType)
gets the text from a text frame and converts it to an integer.
|
protected java.lang.String |
getV23Title()
finds the ID3v2.3
FrameType.SONG_TITLE text frame in the ID3v2.3 tag and retrieves the text field. |
protected int |
getV23Track()
finds the ID3v2.3
FrameType.TRACK_NUMBER text frame in the ID3v2.3 tag and retrieves the text field. |
protected java.lang.String |
getV23UnsynchronizedLyrics(Language language)
finds the unsynchronized song lyrics in the specified language in the ID3v2.3 tag.
|
protected ID3v23Frame |
getV23UnsynchronizedLyricsFrame(Language language)
finds the ID3v2.3 unsynchronized lyrics frame containing in the specified language in the ID3v2.3 tag.
|
int |
getV23Year()
finds the ID3v2.3
FrameType.YEAR text frame in the ID3v2.3 tag and retrieves the text field. |
boolean |
hasV23Errors()
determines if the ID3v2.3 tag had any frame errors when it was read in.
|
protected ID3v23Frame |
removeV23Album()
removes the ID3v2.3
FrameType.ALBUM_TITLE text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23AttachedPicture(PictureType pictureType)
removes the ID3v2.3 attached picture frame with the specified picture type from the ID3v2.3 tag.
|
protected java.util.List<AttachedPicture> |
removeV23AttachedPictures()
removes all ID3v2.3 attached picture frames from the ID3v2.3 tag.
|
protected ID3v23Frame |
removeV23AudioDuration()
removes the ID3v2.3
FrameType.LENGTH text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23AudioSize()
removes the ID3v2.3
FrameType.SIZE text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23Band()
removes the ID3v2.3
FrameType.BAND text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23Comments()
removes the english language song comments from the ID3v2.3 tag.
|
protected ID3v23Frame |
removeV23Comments(Language language)
removes the ID3v2.3 song comments written in the specified language from the ID3v2.3 tag.
|
ID3v23Frame |
removeV23Frame(FrameType frameType)
removes the first ID3v2.3 frame with the specified ID3v2.3 frame id from the ID3v2.3 tag.
|
java.util.List<ID3v23Frame> |
removeV23Frames(FrameType frameType)
removes all the ID3v2.3 frames with the specified ID3v2.3 frame id from the ID3v2.3 tag.
|
protected ID3v23Frame |
removeV23LeadPerformer()
removes the ID3v2.3
FrameType.LEAD_PERFORMER text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23LyricsBy()
removes the ID3v2.3
FrameType.LYRICIST text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23MusicBy()
removes the ID3v2.3
FrameType.COMPOSER text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23MusicType()
removes the ID3v2.3
FrameType.CONTENT_TYPE text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23Publisher()
removes the ID3v2.3
FrameType.PUBLISHER text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23Rating()
removes the ID3v2.3
FrameType.POPULARIMETER text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23SynchronizedLyrics(Language language)
removes the ID3v2.3 synchronized lyrics frame written in the specified language from the ID3v2.3 tag.
|
protected ID3v23Frame |
removeV23Title()
removes the ID3v2.3
FrameType.SONG_TITLE text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23Track()
removes the ID3v2.3
FrameType.TRACK_NUMBER text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
removeV23UnsynchronizedLyrics(Language language)
removes the ID3v2.3 unsynchronized lyrics frame written in the specified language from the ID3v2.3 tag.
|
protected ID3v23Frame |
removeV23Year()
removes the ID3v2.3
FrameType.YEAR text frame in the ID3v2.3 tag. |
protected ID3v23Frame |
setV23Album(java.lang.String album)
adds an ID3v2.3
FrameType.ALBUM_TITLE text frame with the specified album to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23AttachedPicture(AttachedPicture attachedPicture)
adds an ID3v2.3 attached picture frame with the specified picture type to the ID3v2.3 tag.
|
protected ID3v23Frame |
setV23AudioDuration(int duration)
adds an ID3v2.3
FrameType.LENGTH text frame with the specified duration to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23AudioSize(int size)
adds an ID3v2.3
FrameType.SIZE text frame with the specified size to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23Band(java.lang.String band)
adds an ID3v2.3
FrameType.BAND text frame with the specified band to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23Comments(Language language,
java.lang.String comments)
adds an ID3v2.3 comments frame with the comments written in the specified language to the ID3v2.3 tag.
|
protected ID3v23Frame |
setV23LeadPerformer(java.lang.String leadPerformer)
adds an ID3v2.3
FrameType.LEAD_PERFORMER text frame with the specified lead performer to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23LyricsBy(java.lang.String lyricist)
adds an ID3v2.3
FrameType.LYRICIST text frame with the specified title to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23MusicBy(java.lang.String composer)
adds an ID3v2.3
FrameType.COMPOSER text frame with the specified title to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23MusicType(Genre genre)
adds an ID3v2.3
FrameType.CONTENT_TYPE text frame with the specified genre to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23MusicType(java.lang.String genre)
adds an ID3v2.3
FrameType.CONTENT_TYPE text frame with the specified genre to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23Publisher(java.lang.String publisher)
adds an ID3v2.3
FrameType.PUBLISHER text frame with the specified title to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23Rating(int rating)
adds an ID3v2.3
FrameType.POPULARIMETER frame with the specified rating to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23SynchronizedLyrics(Encoding encoding,
Language language,
java.util.List<SynchronizedLyric> synchronizedLyrics)
adds an ID3v2.3 synchronized lyrics frame with the specified song lyrics written in the given language to the ID3v2.3 tag.
|
protected ID3v23Frame |
setV23SynchronizedLyrics(Language language,
java.util.List<SynchronizedLyric> synchronizedLyrics)
adds an ID3v2.3 synchronized lyrics frame with the specified song lyrics written in the given language to the ID3v2.3 tag.
|
protected ID3v23Frame |
setV23SynchronizedLyrics(java.util.List<SynchronizedLyric> synchronizedLyrics)
adds an ID3v2.3 synchronized lyrics frame with the specified english song lyrics to the ID3v2.3 tag.
|
protected ID3v23Frame |
setV23Text(Encoding encoding,
java.lang.String text,
FrameType frameType)
adds an ID3v2.3 text frame with the specified text to the ID3v2.3 tag.
|
ID3v23Frame |
setV23Text(int n,
FrameType frameType)
adds an ID3v2.3 text frame with the string value of the specified integer to the ID3v2.3 tag.
|
protected ID3v23Frame |
setV23Text(java.lang.String text,
FrameType frameType)
adds an ID3v2.3 text frame with the specified text to the ID3v2.3 tag.
|
protected ID3v23Frame |
setV23Title(java.lang.String title)
adds an ID3v2.3
FrameType.SONG_TITLE text frame with the specified title to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23Track(int track)
adds an ID3v2.3
FrameType.TRACK_NUMBER text frame with the specified size to the ID3v2.3 tag. |
protected ID3v23Frame |
setV23UnsynchronizedLyrics(Language language,
java.lang.String lyrics)
adds an ID3v2.3 unsynchronized lyrics frame with the specified song lyrics written in the given language to the ID3v2.3 tag.
|
protected ID3v23Frame |
setV23Year(int year)
adds an ID3v2.3
FrameType.YEAR text frame with the specified year to the ID3v2.3 tag. |
protected ID3v23Tag id3v23Tag
public boolean hasV23Errors()
public java.util.List<java.lang.String> getV23Errors()
public ID3v23Tag getID3v23Tag()
public ID3v23Frame addV23Frame(FrameType frameType)
frameType
- type of ID3v2.3 frame to add to the ID3v2.3 tag.public ID3v23Frame getV23Frame(FrameType frameType)
frameType
- type of ID3v2.3 frame to search for.public java.util.List<ID3v23Frame> getV23Frames(FrameType frameType)
frameType
- type of ID3v2.3 frames to retrieve from the ID3v2.3 tag.public ID3v23Frame removeV23Frame(FrameType frameType)
frameType
- type of type ID3v2.3 frame to remove from the ID3v2.3 tag.public java.util.List<ID3v23Frame> removeV23Frames(FrameType frameType)
frameType
- type of ID3v2.3 frame to remove from the ID3v2.3 tag.protected java.lang.String getV23Album()
FrameType.ALBUM_TITLE
text frame in the ID3v2.3 tag and retrieves the text field.FrameType.ALBUM_TITLE
text frame.
If no ID3v2.3 FrameType.ALBUM_TITLE
text frame is found in the ID3v2.3 tag, then null is returned.protected ID3v23Frame setV23Album(java.lang.String album)
FrameType.ALBUM_TITLE
text frame with the specified album to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.ALBUM_TITLE
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.ALBUM_TITLE
text frame is added to the ID3v2.3 tag.album
- the name of the album on which the .mp3 song was released. The text is encoded using the UTF-16 character set.FrameType.ALBUM_TITLE
text frame that was added/updated.protected ID3v23Frame removeV23Album()
FrameType.ALBUM_TITLE
text frame in the ID3v2.3 tag.FrameType.ALBUM_TITLE
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.ALBUM_TITLE
text frame, then no frame is removed and null is returned.protected AttachedPicture getV23AttachedPicture(PictureType pictureType)
FrameType.ATTACHED_PICTURE
frame in the ID3v2.3 tag and retrieves the attached picture.pictureType
- one of the 21 allowable ID3v2.3 picture types.FrameType.ATTACHED_PICTURE
frame.
If no ID3v2.3 FrameType.ATTACHED_PICTURE
frame is found in the ID3v2.3 tag, then null is returned.protected java.util.List<AttachedPicture> getV23AttachedPictures()
FrameType.ATTACHED_PICTURE
frames in the ID3v2.3 tag and retrieves the attached picture for each frame.FrameType.ATTACHED_PICTURE
frames.
If no ID3v2.3 FrameType.ATTACHED_PICTURE
frames are found in the ID3v2.3 tag, then an empty list is returned.protected ID3v23Frame getV23AttachedPictureFrame(PictureType pictureType)
pictureType
- one of the 21 allowable ID3v2.3 picture types.protected ID3v23Frame setV23AttachedPicture(AttachedPicture attachedPicture)
attachedPicture
- an attached picture containing the information about the image to be added to the ID3V2.3 tag.protected ID3v23Frame removeV23AttachedPicture(PictureType pictureType)
pictureType
- one of the 21 valid ID3v2.3 picture types.protected java.util.List<AttachedPicture> removeV23AttachedPictures()
public int getV23AudioDuration()
FrameType.LENGTH
text frame in the ID3v2.3 tag and retrieves the text field.
The text field is then converted to an integer and returned.FrameType.LENGTH
text frame.
If no ID3v2.3 FrameType.LENGTH
text frame is found in the ID3v2.3 tag, or if the text field is not a valid integer,
then 0 is returned.protected ID3v23Frame setV23AudioDuration(int duration) throws java.lang.IllegalArgumentException
FrameType.LENGTH
text frame with the specified duration to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.LENGTH
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.LENGTH
text frame is added to the ID3v2.3 tag.duration
- the duration (in seconds) of the song in the .mp3 file.FrameType.LENGTH
text frame that was added/updated.java.lang.IllegalArgumentException
- If the duration is less than 0.protected ID3v23Frame removeV23AudioDuration()
FrameType.LENGTH
text frame in the ID3v2.3 tag.FrameType.LENGTH
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.LENGTH
text frame, then no frame is removed and null is returned.protected int getV23AudioSize()
FrameType.SIZE
text frame in the ID3v2.3 tag and retrieves the text field.
The text field is then converted to an integer and returned.FrameType.SIZE
text frame.
If no ID3v2.3 FrameType.SIZE
text frame is found in the ID3v2.3 tag, or if the text field is not a valid integer,
then 0 is returned.protected ID3v23Frame setV23AudioSize(int size) throws java.lang.IllegalArgumentException
FrameType.SIZE
text frame with the specified size to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.SIZE
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.SIZE
text frame is added to the ID3v2.3 tag.size
- the size (in bytes) of the audio portion of the .mp3 file.FrameType.SIZE
text frame that was added/updated.java.lang.IllegalArgumentException
- If the size is less than 1.protected ID3v23Frame removeV23AudioSize()
FrameType.SIZE
text frame in the ID3v2.3 tag.FrameType.SIZE
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.SIZE
text frame, then no frame is removed and null is returned.protected java.lang.String getV23Band()
FrameType.BAND
text frame in the ID3v2.3 tag and retrieves the text field.FrameType.BAND
text frame.
If no ID3v2.3 FrameType.BAND
text frame is found in the ID3v2.3 tag, then null is returned.protected ID3v23Frame setV23Band(java.lang.String band)
FrameType.BAND
text frame with the specified band to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.BAND
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.BAND
text frame is added to the ID3v2.3 tag.band
- the name of the band who recorded the song. The text is encoded using the UTF-16 character set.FrameType.BAND
text frame that was added/updated.protected ID3v23Frame removeV23Band()
FrameType.BAND
text frame in the ID3v2.3 tag.FrameType.BAND
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.BAND
text frame, then no frame is removed and null is returned.protected java.lang.String getV23Comments(Language language) throws java.lang.IllegalArgumentException
language
- the ISO-639-2 language code of the language the song comments are written in.java.lang.IllegalArgumentException
protected ID3v23Frame getV23CommentsFrame(Language language)
language
- the ISO-639-2 language code of the language the song comments are written in.protected ID3v23Frame setV23Comments(Language language, java.lang.String comments) throws java.lang.IllegalArgumentException
language
- the ISO-639-2 language code of the language the song comments are written in.comments
- the comments about the song.java.lang.IllegalArgumentException
- if the comments are empty or contain only whitespace.protected ID3v23Frame removeV23Comments() throws java.lang.IllegalStateException
java.lang.IllegalStateException
protected ID3v23Frame removeV23Comments(Language language) throws java.lang.IllegalArgumentException
language
- the ISO-639-2 language code of the language the song comments are written in.java.lang.IllegalArgumentException
protected java.lang.String getV23LeadPerformer()
protected ID3v23Frame setV23LeadPerformer(java.lang.String leadPerformer)
FrameType.LEAD_PERFORMER
text frame with the specified lead performer to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.LEAD_PERFORMER
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.LEAD_PERFORMER
text frame is added to the ID3v2.3 tag.
On Windows machines, this field is called "Contributing Artist".leadPerformer
- the name of the lead performer on which the .mp3 song was released. The text is encoded using the UTF-16 character set.FrameType.LEAD_PERFORMER
text frame that was added/updated.protected ID3v23Frame removeV23LeadPerformer()
FrameType.LEAD_PERFORMER
text frame in the ID3v2.3 tag.
On Windows machines, this field is called "Contributing Artist".FrameType.LEAD_PERFORMER
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.LEAD_PERFORMER
text frame, then no frame is removed and null is returned.protected java.lang.String getV23LyricsBy()
FrameType.LYRICIST
text frame in the ID3v2.3 tag and retrieves the text field.FrameType.LYRICIST
text frame.
If no ID3v2.3 FrameType.LYRICIST
text frame is found in the ID3v2.3 tag, then null is returned.protected ID3v23Frame setV23LyricsBy(java.lang.String lyricist)
FrameType.LYRICIST
text frame with the specified title to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.LYRICIST
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.LYRICIST
text frame is added to the ID3v2.3 tag.lyricist
- the person(s) who wrote the lyrics to the song. The text is encoded using the UTF-16 character set.FrameType.LYRICIST
text frame that was added/updated.protected ID3v23Frame removeV23LyricsBy()
FrameType.LYRICIST
text frame in the ID3v2.3 tag.FrameType.LYRICIST
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.LYRICIST
text frame, then no frame is removed and null is returned.protected java.lang.String getV23MusicBy()
FrameType.COMPOSER
text frame in the ID3v2.3 tag and retrieves the text field.FrameType.COMPOSER
text frame.
If no ID3v2.3 FrameType.COMPOSER
text frame is found in the ID3v2.3 tag, then null is returned.protected ID3v23Frame setV23MusicBy(java.lang.String composer)
FrameType.COMPOSER
text frame with the specified title to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.COMPOSER
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.COMPOSER
text frame is added to the ID3v2.3 tag.composer
- the person(s) who wrote the music to the song. The text is encoded using the UTF-16 character set.FrameType.COMPOSER
text frame that was added/updated.protected ID3v23Frame removeV23MusicBy()
FrameType.COMPOSER
text frame in the ID3v2.3 tag.FrameType.COMPOSER
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.COMPOSER
text frame, then no frame is removed and null is returned.protected java.lang.String getV23MusicType()
FrameType.CONTENT_TYPE
text frame in the ID3v2.3 tag and retrieves the text field.FrameType.CONTENT_TYPE
text frame.
If no ID3v2.3 FrameType.CONTENT_TYPE
text frame is found in the ID3v2.3 tag, then null is returned.protected ID3v23Frame setV23MusicType(Genre genre)
FrameType.CONTENT_TYPE
text frame with the specified genre to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.CONTENT_TYPE
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.CONTENT_TYPE
text frame is added to the ID3v2.3 tag.genre
- the song's music type. That is, the type of music the song would be described as. The text is encoded using the UTF-16 character set.FrameType.CONTENT_TYPE
text frame that was added/updated.protected ID3v23Frame setV23MusicType(java.lang.String genre)
FrameType.CONTENT_TYPE
text frame with the specified genre to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.CONTENT_TYPE
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.CONTENT_TYPE
text frame is added to the ID3v2.3 tag.genre
- the song's music type. That is, the type of music the song would be described as. The text is encoded using the UTF-16 character set.FrameType.CONTENT_TYPE
text frame that was added/updated.protected ID3v23Frame removeV23MusicType()
FrameType.CONTENT_TYPE
text frame in the ID3v2.3 tag.FrameType.CONTENT_TYPE
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.CONTENT_TYPE
text frame, then no frame is removed and null is returned.protected java.lang.String getV23Publisher()
FrameType.PUBLISHER
text frame in the ID3v2.3 tag and retrieves the text field.FrameType.PUBLISHER
text frame.
If no ID3v2.3 FrameType.PUBLISHER
text frame is found in the ID3v2.3 tag, then null is returned.protected ID3v23Frame setV23Publisher(java.lang.String publisher)
FrameType.PUBLISHER
text frame with the specified title to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.PUBLISHER
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.PUBLISHER
text frame is added to the ID3v2.3 tag.publisher
- the publisher of the song. The text is encoded using the UTF-16 character set.FrameType.PUBLISHER
text frame that was added/updated.protected ID3v23Frame removeV23Publisher()
FrameType.PUBLISHER
text frame in the ID3v2.3 tag.FrameType.PUBLISHER
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.PUBLISHER
text frame, then no frame is removed and null is returned.protected int getV23Rating()
FrameType.POPULARIMETER
frame in the ID3v2.3 tag and retrieves the rating field.FrameType.POPULARIMETER
frame.
If no ID3v2.3 FrameType.POPULARIMETER
frame is found in the ID3v2.3 tag, then 0 is returned.protected ID3v23Frame setV23Rating(int rating)
FrameType.POPULARIMETER
frame with the specified rating to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.POPULARIMETER
frame, then the existing frame's rating is simply updated.
Otherwise, a new ID3v2.3 FrameType.POPULARIMETER
frame is added to the ID3v2.3 tag.rating
- the rating of the song. The rating is 1-255 where 1 is worst and 255 is best. 0 is unknown, or unrated.FrameType.POPULARIMETER
frame that was added/updated.java.lang.IllegalArgumentException
- If the rating is less than 0 or greater than 255.protected ID3v23Frame removeV23Rating()
FrameType.POPULARIMETER
text frame in the ID3v2.3 tag.FrameType.POPULARIMETER
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.POPULARIMETER
text frame, then no frame is removed and null is returned.protected java.util.List<SynchronizedLyric> getV23SynchronizedLyrics(Language language)
language
- the ISO-639-2 language code of the language the song lyrics are written in.protected ID3v23Frame getV23SynchronizedLyricsFrame(Language language)
language
- the ISO-639-2 language code of the language the synchronized song lyrics are written in.protected ID3v23Frame setV23SynchronizedLyrics(java.util.List<SynchronizedLyric> synchronizedLyrics)
synchronizedLyrics
- the synchronized (english) lyrics to the song. The lyrics are encoded using the UTF-16 character set.protected ID3v23Frame setV23SynchronizedLyrics(Language language, java.util.List<SynchronizedLyric> synchronizedLyrics) throws java.lang.IllegalArgumentException
language
- the ISO-639-2 language code of the language the song lyrics are written in.synchronizedLyrics
- a list of synchronized lyrics to the song. The lyrics must be in chronological order.java.lang.IllegalArgumentException
- if the synchronized lyrics are not sorted in ascending chronological order.protected ID3v23Frame setV23SynchronizedLyrics(Encoding encoding, Language language, java.util.List<SynchronizedLyric> synchronizedLyrics) throws java.lang.IllegalArgumentException
encoding
- the character set used to encode the lyrics. Only ISO 8859-1 and UTF-16 are allowed.language
- the ISO-639-2 language code of the language the song lyrics are written in.synchronizedLyrics
- a list of synchronized lyrics to the song. The lyrics must be in chronological order.java.lang.IllegalArgumentException
- if the synchronized lyrics are not sorted in ascending chronological order.protected ID3v23Frame removeV23SynchronizedLyrics(Language language)
language
- the ISO-639-2 language code of the language the synchronized song lyrics are written in.protected java.lang.String getV23Text(FrameType frameType)
frameType
- one of the ID3v2.3 text frame types.protected int getV23TextAsInteger(FrameType frameType)
frameType
- ID3v2.3 text frame type.protected ID3v23Frame setV23Text(java.lang.String text, FrameType frameType)
text
- the text to be added to the ID3v2.3 tag. The text is encoded using the UTF-16 character set.frameType
- the type of ID3v2.3 text frame to add.public ID3v23Frame setV23Text(int n, FrameType frameType) throws java.lang.IllegalArgumentException
n
- the integer whose value will be converted to a string and stored in a text frame in the ID3v2.3 tag.
The text is encoded using the ISO 8859-1 character set.frameType
- the type of ID3v2.3 text frame to add.java.lang.IllegalArgumentException
- If the number n is <= 0.protected ID3v23Frame setV23Text(Encoding encoding, java.lang.String text, FrameType frameType)
encoding
- the character set used to encode the text. Only ISO 8859-1 and UTF-16 are allowed.text
- the text to be added to the ID3v2.3 tag.frameType
- the type of ID3v2.3 text frame to add.protected java.lang.String getV23Title()
FrameType.SONG_TITLE
text frame in the ID3v2.3 tag and retrieves the text field.FrameType.SONG_TITLE
text frame.
If no ID3v2.3 FrameType.SONG_TITLE
text frame is found in the ID3v2.3 tag, then null is returned.protected ID3v23Frame setV23Title(java.lang.String title)
FrameType.SONG_TITLE
text frame with the specified title to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.SONG_TITLE
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.SONG_TITLE
text frame is added to the ID3v2.3 tag.title
- the name of the .mp3 song. The text is encoded using the UTF-16 character set.FrameType.SONG_TITLE
text frame that was added/updated.protected ID3v23Frame removeV23Title()
FrameType.SONG_TITLE
text frame in the ID3v2.3 tag.FrameType.SONG_TITLE
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.SONG_TITLE
text frame, then no frame is removed and null is returned.protected int getV23Track()
FrameType.TRACK_NUMBER
text frame in the ID3v2.3 tag and retrieves the text field.
The text field is then converted to an integer and returned.FrameType.TRACK_NUMBER
text frame.
If no ID3v2.3 FrameType.TRACK_NUMBER
text frame is found in the ID3v2.3 tag, or if the text field is not a valid integer,
then 0 is returned.protected ID3v23Frame setV23Track(int track) throws java.lang.IllegalArgumentException
FrameType.TRACK_NUMBER
text frame with the specified size to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.TRACK_NUMBER
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.TRACK_NUMBER
text frame is added to the ID3v2.3 tag.track
- the track number of the song. It must be >= 1.FrameType.TRACK_NUMBER
text frame that was added/updated.java.lang.IllegalArgumentException
- If the duration is less than 1.protected ID3v23Frame removeV23Track()
FrameType.TRACK_NUMBER
text frame in the ID3v2.3 tag.FrameType.TRACK_NUMBER
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.TRACK_NUMBER
text frame, then no frame is removed and null is returned.protected java.lang.String getV23UnsynchronizedLyrics(Language language)
language
- the ISO-639-2 language code of the language the song lyrics are written in.protected ID3v23Frame getV23UnsynchronizedLyricsFrame(Language language)
language
- the ISO-639-2 language code of the language the unsynchronized song lyrics are written in.protected ID3v23Frame setV23UnsynchronizedLyrics(Language language, java.lang.String lyrics)
language
- the ISO-639-2 language code of the language the song lyrics are written in.lyrics
- the unsynchronized lyrics to the song.protected ID3v23Frame removeV23UnsynchronizedLyrics(Language language)
language
- the ISO-639-2 language code of the language the unsynchronized song lyrics are written in.public int getV23Year()
FrameType.YEAR
text frame in the ID3v2.3 tag and retrieves the text field.
The text field is then converted to an integer and returned.FrameType.YEAR
text frame.
If no ID3v2.3 FrameType.YEAR
text frame is found in the ID3v2.3 tag, or if the text field is not a valid integer,
then 0 is returned.protected ID3v23Frame setV23Year(int year) throws java.lang.IllegalArgumentException
FrameType.YEAR
text frame with the specified year to the ID3v2.3 tag.
If the ID3v2.3 tag already contains an ID3v2.3 FrameType.YEAR
text frame, then the existing frame's text is simply updated.
Otherwise, a new ID3v2.3 FrameType.YEAR
text frame is added to the ID3v2.3 tag.year
- the year the song was recorded. It must be >= 1.FrameType.YEAR
text frame that was added/updated.java.lang.IllegalArgumentException
- If the year is less than 0.protected ID3v23Frame removeV23Year()
FrameType.YEAR
text frame in the ID3v2.3 tag.FrameType.YEAR
text frame that was removed.
If the ID3v2.3 tag does not contain an ID3v2.3 FrameType.YEAR
text frame, then no frame is removed and null is returned.