MP3FileID3Controller (javamod 2.2 API)

java.lang.Object
- de.quippy.javamod.multimedia.mp3.id3.MP3FileID3Controller

public class MP3FileID3Controller
extends Object

Since:: 24.12.2008
Author:: Daniel Becker

Field Summary

Fields
Modifier and Type Field and Description

static int ID3V1

static int ID3V2

Fields
Modifier and Type	Field and Description
`static int`	`ID3V1`
`static int`	`ID3V2`

Constructor Summary

Constructors
Constructor and Description

MP3FileID3Controller(RandomAccessInputStream raf)

MP3FileID3Controller(URL mp3URL)

Constructors
Constructor and Description
`MP3FileID3Controller(RandomAccessInputStream raf)`
`MP3FileID3Controller(URL mp3URL)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAlbum(int type)` Returns the album of the mp3 if set and the empty string if not.
`String`	`getAlbumArtist()` Returns the album artist of this mp3 if set and the empty string if not (id3v2 only).
`String`	`getArtist(int type)` Returns the artist of the mp3 if set and the empty string if not.
`int`	`getBitRate()` Returns the bit rate of this mp3 in kbps.
`String`	`getBPM()` Returns the BPM of this song (id3v2 only).
`String`	`getComment(int type)` Returns the comment field of this mp3 if set and the empty string if not.
`String`	`getComposer()` Returns the composer of this mp3 if set and the empty string if not (id3v2 only).
`String`	`getCopyrightInfo()` Returns the copyright info of this mp3 if set and the empty string if not (id3v2 only).
`String`	`getDisc()` Returns the number of CD this song is on (id3v2 only).
`String`	`getEncodedBy()` Returns who encoded this mp3 if set and the empty string if not (id3v2 only).
`String`	`getFileName()` returns the full path of this mp3 file
`byte[]`	`getFrameDataBytes(String id)` Returns the data contained in the frame specified by the id (id3v2 only) .
`String`	`getFrameDataString(String id)` Returns the textual information contained in the frame specifed by the id.
`String`	`getGenre(int type)` Returns the genre of this mp3 if set and the empty string if not.
`String`	`getMPEGChannelMode()` Return the channel mode of the mpeg.
`String`	`getMPEGEmphasis()` Returns the emphasis of this mp3.
`String`	`getMPEGLayer()` Returns a string specifying the layer of the mpeg.
`String`	`getMPEGVersion()` Returns a string specifying the version of the mpeg.
`String`	`getOriginalArtist()` Returns the original artist of this mp3 if set and the empty string if not (id3v2 only).
`long`	`getPlayingTime()` Returns the length (in seconds) of the playing time of this mp3.
`String`	`getPlayingTimeString()` Return a formatted version of the getPlayingTime method.
`String`	`getPublisher()` Returns the original artist of this mp3 if set and the empty string if not (id3v2 only).
`int`	`getSampleRate()` Returns the sample rate of this mp3 in Hz.
`String`	`getShortDescription()` A short description like winamp does in its default
`String`	`getTitle(int type)` Returns the title of this mp3 if set and the empty string if not.
`String`	`getTrack(int type)` Returns the track of this mp3 if set and the empty string if not.
`String`	`getUserDefinedURL()` Returns the user defined url of this mp3 if set and the empty string if not (id3v2 only).
`String`	`getYear(int type)` Returns the year of this mp3 if set and the empty string if not.
`boolean`	`id3v1Exists()` Returns true if an id3v1 tag currently exists.
`boolean`	`id3v2Exists()` Returns true if an id3v2 tag currently exists.
`boolean`	`isMP3()` Returns true if this file is an mp3.
`boolean`	`isMPEGCopyrighted()` Returns true if this mpeg is copyrighted.
`boolean`	`isMPEGOriginal()` Returns true if this mpeg is the original.
`boolean`	`isMPEGProtected()` Returns true if this mpeg is protected by CRC.
`void`	`removeTags(int type)` Removes id3 tags from the file.
`void`	`setAlbum(String album, int type)` Set the album of this mp3.
`void`	`setArtist(String artist, int type)` Set the artist of this mp3.
`void`	`setComment(String comment, int type)` Add a comment to this mp3.
`void`	`setComposer(String composer)` Set the composer of this mp3 (id3v2 only).
`void`	`setCopyrightInfo(String copyright)` Add some copyright information to this mp3 (id3v2 only).
`void`	`setEncodedBy(String encBy)` Set who encoded the mp3 (id3v2 only).
`void`	`setFrameData(String id, byte[] data)` Set the data of the frame specified by the id (id3v2 only).
`void`	`setGenre(String genre, int type)` Set the genre of this mp3.
`void`	`setOriginalArtist(String artist)` Set the original artist of this mp3 (id3v2 only).
`void`	`setTextFrame(String id, String data)` Set the text of the text frame specified by the id (id3v2 only).
`void`	`setTitle(String title, int type)` Set the title of this mp3.
`void`	`setTrack(int track, int type)` Set the track number of this mp3.
`void`	`setUserDefinedText(String desc, String text)` Add a field of miscellaneous text (id3v2 only).
`void`	`setUserDefinedURL(String desc, String url)` Add a link to this mp3 (id3v2 only).
`void`	`setYear(String year, int type)` Set the year of this mp3.
`String`	`toString()` Return a string representation of this object.
`void`	`writeTags()` Writes the current state of the id3 tags to the file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ID3V1
```
public static final int ID3V1
```
    See Also:
    Constant Field Values
  - ID3V2
```
public static final int ID3V2
```
    See Also:
    Constant Field Values
- Constructor Detail
  - MP3FileID3Controller
```
public MP3FileID3Controller(URL mp3URL)
```
  - MP3FileID3Controller
```
public MP3FileID3Controller(RandomAccessInputStream raf)
```
- Method Detail
  - removeTags
```
public void removeTags(int type)
                throws FileNotFoundException,
                       IOException
```
    Removes id3 tags from the file. The argument specifies which tags to remove. This can either be BOTH_TAGS, ID3V1_ONLY, ID3V2_ONLY, or EXISTING_TAGS_ONLY.
    
    Parameters:
    type - specifies what tag(s) to remove
    
    Throws:
    
    FileNotFoundException - if an error occurs
    
    IOException - if an error occurs
  - writeTags
```
public void writeTags()
               throws FileNotFoundException,
                      IOException
```
    Writes the current state of the id3 tags to the file. What tags are written depends upon the tagType passed to the constructor.
    
    Throws:
    
    FileNotFoundException - if an error occurs
    
    IOException - if an error occurs
  - setTitle
```
public void setTitle(String title,
            int type)
```
    Set the title of this mp3.
    
    Parameters:
    title - the title of the mp3
  - setAlbum
```
public void setAlbum(String album,
            int type)
```
    Set the album of this mp3.
    
    Parameters:
    album - the album of the mp3
  - setArtist
```
public void setArtist(String artist,
             int type)
```
    Set the artist of this mp3.
    
    Parameters:
    artist - the artist of the mp3
  - setComment
```
public void setComment(String comment,
              int type)
```
    Add a comment to this mp3.
    
    Parameters:
    comment - a comment to add to the mp3
  - setGenre
```
public void setGenre(String genre,
            int type)
```
    Set the genre of this mp3.
    
    Parameters:
    genre - the genre of the mp3
  - setYear
```
public void setYear(String year,
           int type)
```
    Set the year of this mp3.
    
    Parameters:
    year - of the mp3
  - setTrack
```
public void setTrack(int track,
            int type)
```
    Set the track number of this mp3.
    
    Parameters:
    track - the track number of this mp3
  - setComposer
```
public void setComposer(String composer)
```
    Set the composer of this mp3 (id3v2 only).
    
    Parameters:
    composer - the composer of this mp3
  - setOriginalArtist
```
public void setOriginalArtist(String artist)
```
    Set the original artist of this mp3 (id3v2 only).
    
    Parameters:
    artist - the original artist of this mp3
  - setCopyrightInfo
```
public void setCopyrightInfo(String copyright)
```
    Add some copyright information to this mp3 (id3v2 only).
    
    Parameters:
    copyright - copyright information related to this mp3
  - setUserDefinedURL
```
public void setUserDefinedURL(String desc,
                     String url)
```
    Add a link to this mp3 (id3v2 only). This includes a description of the url and the url itself.
    
    Parameters:
    desc - a description of the url
    url - the url itself
  - setUserDefinedText
```
public void setUserDefinedText(String desc,
                      String text)
```
    Add a field of miscellaneous text (id3v2 only). This includes a description of the text and the text itself.
    
    Parameters:
    desc - a description of the text
    text - the text itself
  - setEncodedBy
```
public void setEncodedBy(String encBy)
```
    Set who encoded the mp3 (id3v2 only).
    
    Parameters:
    encBy - who encoded the mp3
  - setTextFrame
```
public void setTextFrame(String id,
                String data)
```
    Set the text of the text frame specified by the id (id3v2 only). The id should be one of the static strings specifed in ID3v2Frames class. All id's that begin with 'T' (excluding "TXXX") are considered text frames.
    
    Parameters:
    id - the id of the frame to set the data for
    data - the data to set
  - setFrameData
```
public void setFrameData(String id,
                byte[] data)
```
    Set the data of the frame specified by the id (id3v2 only). The id should be one of the static strings specified in ID3v2Frames class.
    
    Parameters:
    id - the id of the frame to set the data for
    data - the data to set
  - getPlayingTime
```
public long getPlayingTime()
```
    Returns the length (in seconds) of the playing time of this mp3. This will not return an accurate value for VBR files.
    
    Returns:
    the playing time (in seconds) of this mp3
  - getPlayingTimeString
```
public String getPlayingTimeString()
```
    Return a formatted version of the getPlayingTime method. The string will be formated "m:ss" where 'm' is minutes and 'ss' is seconds.
    
    Returns:
    a formatted version of the getPlayingTime method
  - id3v2Exists
```
public boolean id3v2Exists()
```
    Returns true if an id3v2 tag currently exists.
    
    Returns:
    true if an id3v2 tag currently exists
  - id3v1Exists
```
public boolean id3v1Exists()
```
    Returns true if an id3v1 tag currently exists.
    
    Returns:
    true if an id3v1 tag currently exists
  - isMP3
```
public boolean isMP3()
```
    Returns true if this file is an mp3. This means simply that an MPEGAudioFrameHeader was found and the layer is 3.
    
    Returns:
    true if this file is an mp3
  - getBitRate
```
public int getBitRate()
```
    Returns the bit rate of this mp3 in kbps.
    
    Returns:
    the bit rate of this mp3 in kbps
  - getSampleRate
```
public int getSampleRate()
```
    Returns the sample rate of this mp3 in Hz.
    
    Returns:
    the sample reate of this mp3 in Hz
  - getMPEGEmphasis
```
public String getMPEGEmphasis()
```
    Returns the emphasis of this mp3.
    
    Returns:
    the emphasis of this mp3
  - getMPEGLayer
```
public String getMPEGLayer()
```
    Returns a string specifying the layer of the mpeg. Ex: Layer III
    
    Returns:
    a string specifying the layer of the mpeg
  - getMPEGVersion
```
public String getMPEGVersion()
```
    Returns a string specifying the version of the mpeg. This can either be 1.0, 2.0, or 2.5.
    
    Returns:
    a string specifying the version of the mpeg
  - getMPEGChannelMode
```
public String getMPEGChannelMode()
```
    Return the channel mode of the mpeg. Ex: Stereo
    
    Returns:
    the channel mode of the mpeg
  - isMPEGCopyrighted
```
public boolean isMPEGCopyrighted()
```
    Returns true if this mpeg is copyrighted.
    
    Returns:
    true if this mpeg is copyrighted
  - isMPEGOriginal
```
public boolean isMPEGOriginal()
```
    Returns true if this mpeg is the original.
    
    Returns:
    true if this mpeg is the original
  - isMPEGProtected
```
public boolean isMPEGProtected()
```
    Returns true if this mpeg is protected by CRC.
    
    Returns:
    true if this mpeg is protected by CRC
  - getArtist
```
public String getArtist(int type)
```
    Returns the artist of the mp3 if set and the empty string if not.
    
    Returns:
    the artist of the mp3
    
    Throws:
    
    ID3v2FormatException - if the data of the field is incorrect
  - getAlbum
```
public String getAlbum(int type)
```
    Returns the album of the mp3 if set and the empty string if not.
    
    Returns:
    the album of the mp3
    
    Throws:
    
    ID3v2FormatException - if the data of the field is incorrect
  - getComment
```
public String getComment(int type)
```
    Returns the comment field of this mp3 if set and the empty string if not.
    
    Returns:
    the comment field of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of the field is incorrect
  - getGenre
```
public String getGenre(int type)
```
    Returns the genre of this mp3 if set and the empty string if not.
    
    Returns:
    the genre of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getTitle
```
public String getTitle(int type)
```
    Returns the title of this mp3 if set and the empty string if not.
    
    Returns:
    the title of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getTrack
```
public String getTrack(int type)
```
    Returns the track of this mp3 if set and the empty string if not.
    
    Returns:
    the track of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getYear
```
public String getYear(int type)
```
    Returns the year of this mp3 if set and the empty string if not.
    
    Returns:
    the year of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getComposer
```
public String getComposer()
```
    Returns the composer of this mp3 if set and the empty string if not (id3v2 only).
    
    Returns:
    the composer of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getDisc
```
public String getDisc()
```
    Returns the number of CD this song is on (id3v2 only).
    
    Returns:
    the number of the CD this song is on
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getOriginalArtist
```
public String getOriginalArtist()
```
    Returns the original artist of this mp3 if set and the empty string if not (id3v2 only).
    
    Returns:
    the original artist of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getAlbumArtist
```
public String getAlbumArtist()
```
    Returns the album artist of this mp3 if set and the empty string if not (id3v2 only).
    
    Returns:
    the album artist of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getPublisher
```
public String getPublisher()
```
    Returns the original artist of this mp3 if set and the empty string if not (id3v2 only).
    
    Returns:
    the original artist of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getCopyrightInfo
```
public String getCopyrightInfo()
```
    Returns the copyright info of this mp3 if set and the empty string if not (id3v2 only).
    
    Returns:
    the copyright info of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getUserDefinedURL
```
public String getUserDefinedURL()
```
    Returns the user defined url of this mp3 if set and the empty string if not (id3v2 only).
    
    Returns:
    the user defined url of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getEncodedBy
```
public String getEncodedBy()
```
    Returns who encoded this mp3 if set and the empty string if not (id3v2 only).
    
    Returns:
    who encoded this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getBPM
```
public String getBPM()
```
    Returns the BPM of this song (id3v2 only).
    
    Returns:
    BPM of this mp3
    
    Throws:
    
    ID3v2FormatException - if the data of this field is incorrect
  - getFrameDataString
```
public String getFrameDataString(String id)
```
    Returns the textual information contained in the frame specifed by the id. If the frame does not contain any textual information or does not exist, then the empty string is returned (id3v2 only). The id should be one of the static strings defined in the ID3v2Frames class.
    
    Parameters:
    id - the id of the frame to get data from
    
    Returns:
    the textual information of the frame
    
    Throws:
    
    ID3v2FormatException - if the data of the frame is incorrect
  - getFrameDataBytes
```
public byte[] getFrameDataBytes(String id)
```
    Returns the data contained in the frame specified by the id (id3v2 only) . If the frame does not exist, a zero length array will be returned. The id should be one of the static strings defined in the ID3v2Frames class.
    
    Parameters:
    id - the id of the frame to get data from
    
    Returns:
    the data contained in the frame
  - getFileName
```
public String getFileName()
```
    returns the full path of this mp3 file
    
    Returns:
    Since:
    
    26.12.2008
  - getShortDescription
```
public String getShortDescription()
```
    A short description like winamp does in its default
    
    Returns:
    Since:
    
    26.12.2008
  - toString
```
public String toString()
```
    Return a string representation of this object. This includes all the information contained within the mpeg header and id3 tags as well as certain file attributes.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of this object

Class MP3FileID3Controller

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID3V1

ID3V2

Constructor Detail

MP3FileID3Controller

MP3FileID3Controller

Method Detail

removeTags

writeTags

setTitle

setAlbum

setArtist

setComment

setGenre

setYear

setTrack

setComposer

setOriginalArtist

setCopyrightInfo

setUserDefinedURL

setUserDefinedText

setEncodedBy

setTextFrame

setFrameData

getPlayingTime

getPlayingTimeString

id3v2Exists

id3v1Exists

isMP3

getBitRate

getSampleRate

getMPEGEmphasis

getMPEGLayer

getMPEGVersion

getMPEGChannelMode

isMPEGCopyrighted

isMPEGOriginal

isMPEGProtected

getArtist

getAlbum

getComment

getGenre

getTitle

getTrack

getYear

getComposer

getDisc

getOriginalArtist

getAlbumArtist

getPublisher

getCopyrightInfo

getUserDefinedURL

getEncodedBy

getBPM

getFrameDataString

getFrameDataBytes

getFileName

getShortDescription

toString