    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class de.vdheide.mp3.MP3File

    java.lang.Object
       |
       +----java.io.File
               |
               +----de.vdheide.mp3.MP3File

public class MP3File
extends File

##

MP3File(File, String)
  Creates a MP3File instance that represents the file with the specified name in the specified directory.
MP3File(String)
  Creates a new instance.
MP3File(String, String)
  Creates a File instance whose pathname is the pathname of the specified directory, followed by the separator character, followed by the name argument.

##

getAlbum()
  Read album/movie/show title.
getArtist()
  Read artist, store as text content.
getArtistWebpage()
  Read official artist / performer webpage, store as text content
getAudioFileWebpage()
  Read official audio file webpage, store as text content
getAudioSourceWebpage()
  Read official audio source webpage, store as text content Used e.g.
getBand()
  Read band (orchestra, accompaniment), store as text content
getBitrate()
getBPM()
  Read BPM.
getCDIdentifier()
  Read Music CD identifier, store as binary content
getComments()
  Read comments, store language as type, description as description and comments as text content
getCommercial()
  Read commercial frame, store as binary content See the ID3v2 informal standard for details on the format of this field.
getCommercialInformation()
  Read Commercial information webpage, store as text content
getComposer()
  Read composer(s), stored as text content.
getConductor()
  Read conductor, store as text content
getContentGroup()
  Read content group description, store as text content.
getCopyright()
getCopyrightText()
  Read copyright, store as text content.
getCopyrightWebpage()
  Read Coypright / legal information webpage, store as text content
getDate()
  Read date (format DDMM), store as text content.
getEmphasis()
  Returns emphasis used in MP3 file Better use constants from MP3Properties.
getEncapsulatedObject()
  Read general encapsulated object, store MIME type as type, filename as text subtype, description as description and object as binary content.
getEncodedBy()
  Read encoded by, store as text content.
getEncryptionMethodRegistration()
  Read encryption method registration, store owner identifier as type, method symbol as binary subtype and encryption data as binary content.
getEqualisation()
  Read equalisation, store as binary content See the ID3v2 informal standard for details on the format of this field.
getEventTimingCodes()
  Read event timing codes, store as binary content See the ID3v2 informal standard for details on the format of this field.
getFileOwner()
  Read file owner, store as text content
getFilesize()
  Get size of file in bytes, excluding id3v2 tag, store as text content
getFileType()
  Read file type, store as text content.
getGenre()
  Read genre (type of music like "Soul", "Rock", etc.) stored as text content.
getGroupIdentificationRegistration()
  Read group identification registration, store owner identifier as type, group symbol as binary subtype and group dependent data as binary content.
getInitialKey()
  Read initial key

  Musical key in which sound starts.

getInternetRadioStationName()
  Get Internet radio station name, store as text content
getInternetRadioStationOwner()
  Get Internet radio station owner, store as text content
getInternetRadioStationWebpage()
  Read official internet radio station webpage, store as text content
getISRC()
  Get International Standard Recording Code, store as text content
getLanguage()
  Read language of lyrics

  Language is represented with three characters according to ISO-639-2.

getLayer()
getLength()
getLengthInTag()
  Read length of audiofile in milliseconds, store as text content.
getLookupTable()
  Read MPEG location lookup table, store as binary content See the ID3v2 informal standard for details on the format of this field.
getLyricist()
  Read lyricist, store as text content.
getMediaType()
  Read media type, store as text content.
getMode()
  Returns mode (mono, stereo, etc.) used in MP3 file Better use constants from MP3Properties.
getMPEGLevel()
getOriginal()
getOriginalArtist()
  Read original artist(s) (for cover songs), store as text content
getOriginalFilename()
  Read original filename, store as text content

  Original filename is used to store prefered filename on media which does have limitations to the filename.

getOriginalLyricist()
  Read original lyricist(s) (for cover songs), store as text content
getOriginalTitle()
  Read original title (for cover songs), store as text content
getOriginalYear()
  Read original release year (format YYYY) (for cover songs), store as text content
getOwnership()
  Read ownership, store as binary content See the ID3v2 informal standard for details on the format of this field.
getPadding()
getPartOfSet()
  Read part of a set (e.g.
getPaymentWebpage()
  Read payment webpage, store as text content
getPicture()
  Read attached picture, store MIME type as type, picture type as binary subtype, description as description and picture data as binary content.
getPlayCounter()
  Read play counter, store as binary content See the ID3v2 informal standard for details on the format of this field.
getPlaylistDelay()
  Read playlist delay, store as text content.
getPopularimeter()
  Read popularimeter, store as binary content See the ID3v2 informal standard for details on the format of this field.
getPositionSynchronization()
  Read position synchronization, store as binary content See the ID3v2 informal standard for details on the format of this field.
getPrivate()
getPrivateData()
  Read private data, store owner identifier as type, private data as binary content.
getProtection()
getPublisher()
  Read publisher, store as text content
getPublishersWebpage()
  Read official publishers webpage, store as text content
getRecommendedBufferSize()
  Read recommended buffer size, store as binary content See the ID3v2 informal standard for details on the format of this field.
getRecordingDates()
  Get recording dates, store as text content
getRelativeVolumenAdjustment()
  Read relative volume adjustment, store as binary content See the ID3v2 informal standard for details on the format of this field.
getRemixer()
  Read remixer, store as text content
getReverb()
  Read reverb, store as binary content See the ID3v2 informal standard for details on the format of this field.
getSamplerate()
getSubtitle()
  Read subtitle, store as text content.
getSynchronizedLyrics()
  Read synchronized lyrics, store as binary content See the ID3v2 informal standard for details on the format of this field.
getSynchronizedTempoCodes()
  Read synchronized tempo codes, store as binary content See the ID3v2 informal standard for details on the format of this field.
getTermsOfUse()
  Read terms of use, store language as type and terms of use as text content
getTime()
  Read time (format HHMM), store as text content.
getTitle()
  Read song title, store as text content.
getTrack()
  Read track number, store in text content.
getUniqueFileIdentifier()
  Read unique file identifier.
getUnsynchronizedLyrics()
  Read unsynchronized lyrics, store language as type, description as description and lyrics as text content
getUseCompression()
getUseCRC()
getUsePadding()
getUserDefinedText()
  Read user defined text, store description as description and value as text content
getUserDefinedURL()
  Read user defined URL, store description as description and URL as text content
getUseUnsynchronization()
getWriteID3()
  Should an ID3 tag be written
getWriteID3v2()
  Should an ID3v2 tag be written?
getYear()
  Get year of recording, store as text content
setAlbum(TagContent)
  Set album.
setArtist(TagContent)
  Set artist, read from text content.
setArtistWebpage(TagContent)
  Set official artist / performer webpage, read from text content.
setAudioFileWebpage(TagContent)
  Set official audio file webpage, read from text content.
setAudioSourceWebpage(TagContent)
  Set official audio source webpage, read from text content.
setBand(TagContent)
  Set band, read from text content.
setBPM(TagContent)
  Set BPM.
setCDIdentifier(TagContent)
  Set music CD identifier, read from binary content.
setComments(TagContent)
  Set comments.
setCommercial(TagContent)
  Set commercial frame, read from binary content.
setCommercialInformation(TagContent)
  Set Commercial information webpage, read from text content.
setComposer(TagContent)
  Set composer(s), read from text content.
setConductor(TagContent)
  Set conductor, read from text content.
setContentGroup(TagContent)
  Set content group description, read from text content.
setCopyrightText(TagContent)
  Set copyright, read from text content.
setCopyrightWebpage(TagContent)
  Set Copyright / legal information webpage, read from text content.
setDate(TagContent)
  Set date (format DDMM), read from text content.
setEncapsulatedObject(TagContent)
  Set general encapsulated object.
setEncodedBy(TagContent)
  Set encoded by, read from text content.
setEncryptionMethodRegistration(TagContent)
  Set encryption method registration.
setEqualisation(TagContent)
  Set equalisation, read from binary content.
setEventTimingCodes(TagContent)
  Set event timing codes, read from binary content.
setFileOwner(TagContent)
  Set file owner, read from text content.
setFilesize(TagContent)
  Set size of files in bytes, excluding id3v2 tag, read from text content.
setFileType(TagContent)
  Set file type, read from text content.
setGenre(TagContent)
  Set genre, read from text content.
setGroupIdentificationRegistration(TagContent)
  Set group identification registration.
setInitialKey(TagContent)
  Set initial key, read from text content.
setInternetRadioStationName(TagContent)
  Set Internet radio station name, read from text content.
setInternetRadioStationOwner(TagContent)
  Set Internet radio station owner, read from text content.
setInternetRadioStationWebpage(TagContent)
  Set official internet radio station webpage, read from text content.
setISRC(TagContent)
  Set International Standard Recording Code, read from text content.
setLanguage(TagContent)
  Set language of lyrics, read from text content.
setLengthInTag(TagContent)
  Set length of audiofile in milliseconds, read from text content.
setLookupTable(TagContent)
  Set MPEG location lookup table, read from binary content.
setLyricist(TagContent)
  Set lyricist, read from text content.
setMediaType(TagContent)
  Set media type, read from text content.
setOriginalArtist(TagContent)
  Set original artist(s), read from text content.
setOriginalFilename(TagContent)
  Set original filename, read from text content.
setOriginalLyricist(TagContent)
  Set original lyricist(s), read from text content.
setOriginalTitle(TagContent)
  Set original title, read from text content.
setOriginalYear(TagContent)
  Set original release year (format YYYY), read from text content.
setOwnership(TagContent)
  Set ownership, read from binary content.
setPartOfSet(TagContent)
  Set part of a set (e.g.
setPaymentWebpage(TagContent)
  Set payment webpage, read from text content.
setPicture(TagContent)
  Set attached picture.
setPlayCounter(TagContent)
  Set play counter, read from binary content.
setPlaylistDelay(TagContent)
  Set playlist delay, read from text content.
setPopularimeter(TagContent)
  Set popularimeter, read from binary content.
setPositionSynchronization(TagContent)
  Set position synchronization, read from binary content.
setPrivateData(TagContent)
  Set private data.
setPublisher(TagContent)
  Set publisher, read from text content.
setPublishersWebpage(TagContent)
  Set official publishers webpage, read from text content.
setRecommendedBufferSize(TagContent)
  Set recommended buffer size, read from binary content.
setRecordingDate(TagContent)
  Set recording date, read from text content.
setRelativeVolumeAdjustment(TagContent)
  Set relative volume adjustment, read from binary content.
setRemixer(TagContent)
  Set remixer, read from text content.
setReverb(TagContent)
  Set reverb, read from binary content.
setSubtitle(TagContent)
  Set subtitle, read from text content.
setSynchronizedLyrics(TagContent)
  Set synchronized lyrics, read from binary content.
setSynchronizedTempoCodes(TagContent)
  Set synchronized tempo codes, read from binary content.
setTermsOfUse(TagContent)
  Set terms of use.
setTime(TagContent)
  Set time (format HHMM), read from text content.
setTitle(TagContent)
  Set title, read from text content.
setTrack(TagContent)
  Set track number, read from text content.
setUniqueFileIdentifier(TagContent)
  Set unique file identifier.
setUnsynchronizedLyrics(TagContent)
  Set unsynchronized lyrics.
setUseCompression(boolean)
  Use compression in ID3v2 tag? Frames are compressed only when the compressed content is smaller than the uncompressed content.
setUseCRC(boolean)
  Use CRC in ID3v2 tag?
setUsePadding(boolean)
  Use padding in ID3v2 tag?
setUserDefinedText(TagContent)
  Set user defined text information.
setUserDefinedURL(TagContent)
  Set user defined URL link.
setUseUnsynchronization(boolean)
  Use unsynchronization in ID3v2 tag?
setWriteID3(boolean)
  Write ID3 tag?
setWriteID3v2(boolean)
  Write ID3v2 tag?
setYear(TagContent)
  Set year of recording, read from text content.
update()
  Commit information to file

##

MP3File

     public MP3File(String filename) throws IOException, NoMP3FrameException, ID3v2WrongCRCException, ID3v2DecompressionException, ID3v2IllegalVersionException

  Creates a new instance. Tag information is completely read the first time it is requested and written after `update()`.

  Parameters:
    filename - File name
  Throws: IOException
    If I/O error occurs
  Throws: NoMP3FrameException
    If file does not contain at least one mp3 frame
  Throws: ID3v2WrongCRCException
    If the ID3v2 tag fails CRC
  Throws: ID3v2DecompressionException
    If the ID3v2 tag cannot be decompressed
  Throws: ID3v2IllegalVersionException
    If the ID3v2 tag has a wrong (too high) version

MP3File

     public MP3File(File dir,
                    String filename) throws IOException, NoMP3FrameException, ID3v2WrongCRCException, ID3v2DecompressionException, ID3v2IllegalVersionException

  Creates a MP3File instance that represents the file with the specified name in the specified directory. Tag information is completely read the first time it is requested and written after `update()`.

  Parameters:
    dir - Directory
    filename - File name
  Throws: IOException
    If I/O error occurs
  Throws: NoMP3FrameException
    If file does not contain at least one mp3 frame
  Throws: ID3v2WrongCRCException
    If the ID3v2 tag fails CRC
  Throws: ID3v2DecompressionException
    If the ID3v2 tag cannot be decompressed
  Throws: ID3v2IllegalVersionException
    If the ID3v2 tag has a wrong (too high) version

MP3File

     public MP3File(String dir,
                    String filename) throws IOException, NoMP3FrameException, ID3v2WrongCRCException, ID3v2DecompressionException, ID3v2IllegalVersionException

  Creates a File instance whose pathname is the pathname of the specified directory, followed by the separator character, followed by the name argument. Tag information is completely read the first time it is requested and written after `update()`.

  Parameters:
    dir - Name of directory
    filename - File name
  Throws: IOException
    If I/O error occurs
  Throws: NoMP3FrameException
    If file does not contain at least one mp3 frame
  Throws: ID3v2WrongCRCException
    If the ID3v2 tag fails CRC
  Throws: ID3v2DecompressionException
    If the ID3v2 tag cannot be decompressed
  Throws: ID3v2IllegalVersionException
    If the ID3v2 tag has a wrong (too high) version

##

update

     public void update() throws ID3Exception, ID3v2Exception

  Commit information to file

  Throws: ID3Exception
    If an error occurs when writing the ID3 tag
  Throws: ID3v2Exception
    If an error ocurrs when writing the ID3v2 tag

setWriteID3

     public void setWriteID3(boolean write_id3)

  Write ID3 tag?

  Parameters:
    write_id3 - True: Write ID3 tag on update

getWriteID3

     public boolean getWriteID3()

  Should an ID3 tag be written

  Returns:
    true if ID3 tag will be written on update

setWriteID3v2

     public void setWriteID3v2(boolean write_id3v2)

  Write ID3v2 tag?

  Parameters:
    write_id3v2 - True: Write ID3v2 tag on update

getWriteID3v2

     public boolean getWriteID3v2()

  Should an ID3v2 tag be written?

  Returns:
    true if ID3v2 tag will be written on update

setUseCompression

     public void setUseCompression(boolean use_compression)

  Use compression in ID3v2 tag? Frames are compressed only when the compressed content is smaller than the uncompressed content.

  Parameters:
    use_compression - True: Use compression

getUseCompression

     public boolean getUseCompression()

  Returns:
    true if compression will be used in ID3v2 tag

setUseCRC

     public void setUseCRC(boolean use_crc)

  Use CRC in ID3v2 tag?

  Parameters:
    use_crc - True: Use CRC

getUseCRC

     public boolean getUseCRC()

  Returns:
    true if CRC will be used in ID3v2 tag

setUsePadding

     public void setUsePadding(boolean use_padding)

  Use padding in ID3v2 tag?

  Parameters:
    use_padding - True: Use padding

getUsePadding

     public boolean getUsePadding()

  Returns:
    true if padding will be used in ID3v2 tag

setUseUnsynchronization

     public void setUseUnsynchronization(boolean use_unsynch)

  Use unsynchronization in ID3v2 tag?

  Parameters:
    use_unsynch - True: Use unsynchronization

getUseUnsynchronization

     public boolean getUseUnsynchronization()

  Returns:
    true if unsynchronization will be used in ID3v2 tag

getMPEGLevel

     public int getMPEGLevel()

  Returns:
    MPEG level (1 or 2)

getLayer

     public int getLayer()

  Returns:
    Layer (1..3)

getBitrate

     public int getBitrate()

  Returns:
    Bitrate

getSamplerate

     public int getSamplerate()

  Returns:
    Samplerate

getMode

     public int getMode()

  Returns mode (mono, stereo, etc.) used in MP3 file Better use constants from MP3Properties.

  Returns:
    Mode

getEmphasis

     public int getEmphasis()

  Returns emphasis used in MP3 file Better use constants from MP3Properties.

  Returns:
    Emphasis

getProtection

     public boolean getProtection()

  Returns:
    Protection (CRC) set

getPrivate

     public boolean getPrivate()

  Returns:
    Private bit set?

getPadding

     public boolean getPadding()

  Returns:
    Padding set?

getCopyright

     public boolean getCopyright()

  Returns:
    Copyright set?

getOriginal

     public boolean getOriginal()

  Returns:
    Original?

getLength

     public long getLength()

  Returns:
    Length in seconds

getAlbum

     public TagContent getAlbum() throws FrameDamagedException

  Read album/movie/show title. Album is stored as text content.

  Returns:
    Album
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setAlbum

     public void setAlbum(TagContent album) throws TagFormatException

  Set album. Album is read from text content.

  Parameters:
    album - Album to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getBPM

     public TagContent getBPM() throws FrameDamagedException

  Read BPM. BPM is stored as text content.

  Returns:
    BPM
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setBPM

     public void setBPM(TagContent bpm) throws TagFormatException

  Set BPM. BPM is read from text content.

  Parameters:
    bpm - BPM to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getComposer

     public TagContent getComposer() throws FrameDamagedException

  Read composer(s), stored as text content.

  Returns:
    composer(s)
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setComposer

     public void setComposer(TagContent composer) throws TagFormatException

  Set composer(s), read from text content.

  Parameters:
    composer - Composer(s) to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getGenre

     public TagContent getGenre() throws FrameDamagedException

  Read genre (type of music like "Soul", "Rock", etc.) stored as text content. ID3v1.1 content is denoted by putting round brackets around the number (like (4)), round brackets in text are escaped by ((.

  Returns:
    Album
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setGenre

     public void setGenre(TagContent genre) throws TagFormatException

  Set genre, read from text content. ID3v1.1 genre is denoted by putting round brackets around the number (like (4)), round brackets in text are escaped by ((.

  Parameters:
    genre - Genre to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getCopyrightText

     public TagContent getCopyrightText() throws FrameDamagedException

  Read copyright, store as text content. According to the ID3v2 informal standard, this has to be preceded when displayed with "Copyright (C)" where (C) is one character showing a C in a circle...

  Returns:
    Copyright
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setCopyrightText

     public void setCopyrightText(TagContent copyright) throws TagFormatException

  Set copyright, read from text content.

  Parameters:
    copyright - Copyright to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getDate

     public TagContent getDate() throws FrameDamagedException

  Read date (format DDMM), store as text content.

  Returns:
    date
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setDate

     public void setDate(TagContent date) throws TagFormatException

  Set date (format DDMM), read from text content.

  Parameters:
    date - Date to set
  Throws: TagFormatException
    If input does not adhere to the format given above.

getPlaylistDelay

     public TagContent getPlaylistDelay() throws FrameDamagedException

  Read playlist delay, store as text content.

  Returns:
    Playlist delay
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setPlaylistDelay

     public void setPlaylistDelay(TagContent delay) throws TagFormatException

  Set playlist delay, read from text content.

  Parameters:
    delay - Playlist delay to set
  Throws: TagFormatException
    If input is not a numeric string

getEncodedBy

     public TagContent getEncodedBy() throws FrameDamagedException

  Read encoded by, store as text content.

  Returns:
    Encoded by
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setEncodedBy

     public void setEncodedBy(TagContent encoder) throws TagFormatException

  Set encoded by, read from text content.

  Parameters:
    encoder - Encoded by to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getLyricist

     public TagContent getLyricist() throws FrameDamagedException

  Read lyricist, store as text content.

  Returns:
    Lyricist
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setLyricist

     public void setLyricist(TagContent lyricist) throws TagFormatException

  Set lyricist, read from text content.

  Parameters:
    lyricist - Lyricist to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getFileType

     public TagContent getFileType() throws FrameDamagedException

  Read file type, store as text content.

  The following types are defined (other types may be used)

  - `MPG` : MPEG Audio
  - `MPG/1` : MPEG 1/2 layer I
  - `MPG/2` : MPEG 1/2 layer II
  - `MPG/3` : MPEG 1/2 layer III
  - `MPG/2.5`: MPEG 2.5
  - `MPG/AAC`: Advanced audio compression
  - `VQF` : Transform-domain weighted interleace vector quantization
  - `PCM` : Pulse code modulated audio

  Returns:
    File type
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setFileType

     public void setFileType(TagContent type) throws TagFormatException

  Set file type, read from text content.

  Parameters:
    type - File type to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getTime

     public TagContent getTime() throws FrameDamagedException

  Read time (format HHMM), store as text content.

  Returns:
    Time
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setTime

     public void setTime(TagContent time) throws TagFormatException

  Set time (format HHMM), read from text content.

  Parameters:
    time - Time to set
  Throws: TagFormatException
    If input does not adhere to the format given above.

getContentGroup

     public TagContent getContentGroup() throws FrameDamagedException

  Read content group description, store as text content.

  Content group description is used if sound belongs to a larger category of sounds, e.g. "Piano Concerto", "Weather - Hurricane")

  Returns:
    Content group
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setContentGroup

     public void setContentGroup(TagContent content) throws TagFormatException

  Set content group description, read from text content.

  Content group description is used if sound belongs to a larger category of sounds, e.g. "Piano Concerto", "Weather - Hurricane")

  Parameters:
    content - Content group description to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getTitle

     public TagContent getTitle() throws FrameDamagedException

  Read song title, store as text content.

  Returns:
    Song title
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setTitle

     public void setTitle(TagContent title) throws TagFormatException

  Set title, read from text content.

  Parameters:
    title - Title to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getSubtitle

     public TagContent getSubtitle() throws FrameDamagedException

  Read subtitle, store as text content.

  Subtitle is used for information directly related to the contents title (e.g. "Op. 16" or "Performed live at Wembley")

  Returns:
    Subtitle
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setSubtitle

     public void setSubtitle(TagContent subtitle) throws TagFormatException

  Set subtitle, read from text content.

  Content group description is used if sound belongs to a larger category of sounds, e.g. "Piano Concerto", "Weather - Hurricane")

  Parameters:
    subtitle - Subtitle to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getInitialKey

     public TagContent getInitialKey() throws FrameDamagedException

  Read initial key

  Musical key in which sound starts. String with max 3 characters, ground keys: A, B, C, D, E, F, G, halfkeys b and #. Minor: m, Off key: o

  Returns:
    Initial key
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setInitialKey

     public void setInitialKey(TagContent key) throws TagFormatException

  Set initial key, read from text content.

  Musical key in which sound starts. String with max 3 characters, ground keys: A, B, C, D, E, F, G, halfkeys b and #. Minor: m, Off key: o

  Parameters:
    key - Initial key to set
  Throws: TagFormatException
    If key is longer than three characters

getLanguage

     public TagContent getLanguage() throws FrameDamagedException

  Read language of lyrics

  Language is represented with three characters according to ISO-639-2.

  Returns:
    Language
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setLanguage

     public void setLanguage(TagContent lang) throws TagFormatException

  Set language of lyrics, read from text content.

  Language is represented with three characters according to ISO-639-2.

  Parameters:
    lang - Language to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getLengthInTag

     public TagContent getLengthInTag() throws FrameDamagedException

  Read length of audiofile in milliseconds, store as text content.

  This returns the length stored in the ID3v2 tag, not the length calculated from file length.

  Returns:
    Length
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setLengthInTag

     public void setLengthInTag(TagContent length) throws TagFormatException

  Set length of audiofile in milliseconds, read from text content.

  Parameters:
    length - Length to set
  Throws: TagFormatException
    If input is not a numeric string

getMediaType

     public TagContent getMediaType() throws FrameDamagedException

  Read media type, store as text content.

  See the ID3v2 informal standard for more information.

  Returns:
    Media type
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setMediaType

     public void setMediaType(TagContent type) throws TagFormatException

  Set media type, read from text content.

  See the ID3v2 informal standard for more information.

  Parameters:
    type - Media type to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getOriginalTitle

     public TagContent getOriginalTitle() throws FrameDamagedException

  Read original title (for cover songs), store as text content

  Returns:
    Original title
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setOriginalTitle

     public void setOriginalTitle(TagContent title) throws TagFormatException

  Set original title, read from text content.

  Parameters:
    title - Original title to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getOriginalFilename

     public TagContent getOriginalFilename() throws FrameDamagedException

  Read original filename, store as text content

  Original filename is used to store prefered filename on media which does have limitations to the filename. It is stored including suffix.

  Returns:
    Original filename
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setOriginalFilename

     public void setOriginalFilename(TagContent filename) throws TagFormatException

  Set original filename, read from text content.

  Original filename is used to store prefered filename on media which have limitations to the filename. It is stored including suffix.

  Parameters:
    filename - Original filename to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getOriginalLyricist

     public TagContent getOriginalLyricist() throws FrameDamagedException

  Read original lyricist(s) (for cover songs), store as text content

  Returns:
    Original lyricist(s)
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setOriginalLyricist

     public void setOriginalLyricist(TagContent lyricist) throws TagFormatException

  Set original lyricist(s), read from text content.

  Parameters:
    lyricist - Original lyricist(s) to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getOriginalArtist

     public TagContent getOriginalArtist() throws FrameDamagedException

  Read original artist(s) (for cover songs), store as text content

  Returns:
    Original artist(s)
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setOriginalArtist

     public void setOriginalArtist(TagContent artist) throws TagFormatException

  Set original artist(s), read from text content.

  Parameters:
    artist - Original artist(s) to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getOriginalYear

     public TagContent getOriginalYear() throws FrameDamagedException

  Read original release year (format YYYY) (for cover songs), store as text content

  Returns:
    Original release year
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setOriginalYear

     public void setOriginalYear(TagContent year) throws TagFormatException

  Set original release year (format YYYY), read from text content.

  Parameters:
    year - Original year to set
  Throws: TagFormatException
    If input is not in the format listed above

getFileOwner

     public TagContent getFileOwner() throws FrameDamagedException

  Read file owner, store as text content

  Returns:
    File owner
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setFileOwner

     public void setFileOwner(TagContent owner) throws TagFormatException

  Set file owner, read from text content.

  Parameters:
    owner - File owner to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getArtist

     public TagContent getArtist() throws FrameDamagedException

  Read artist, store as text content.

  Returns:
    Artist
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setArtist

     public void setArtist(TagContent artist) throws TagFormatException

  Set artist, read from text content.

  Parameters:
    artist - Artist to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getBand

     public TagContent getBand() throws FrameDamagedException

  Read band (orchestra, accompaniment), store as text content

  Returns:
    Band
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setBand

     public void setBand(TagContent band) throws TagFormatException

  Set band, read from text content.

  Parameters:
    band - Band to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getConductor

     public TagContent getConductor() throws FrameDamagedException

  Read conductor, store as text content

  Returns:
    Conductor
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setConductor

     public void setConductor(TagContent conductor) throws TagFormatException

  Set conductor, read from text content.

  Parameters:
    conductor - Conductor to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getRemixer

     public TagContent getRemixer() throws FrameDamagedException

  Read remixer, store as text content

  Returns:
    Remixer
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setRemixer

     public void setRemixer(TagContent remixer) throws TagFormatException

  Set remixer, read from text content.

  Parameters:
    conductor - Remixer to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getPartOfSet

     public TagContent getPartOfSet() throws FrameDamagedException

  Read part of a set (e.g. 1/2 for a double CD), store as text content

  Returns:
    Part of a set
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setPartOfSet

     public void setPartOfSet(TagContent part) throws TagFormatException

  Set part of a set (e.g. 1/2 for a double CD), read from text content.

  Parameters:
    part - Part of a set to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getPublisher

     public TagContent getPublisher() throws FrameDamagedException

  Read publisher, store as text content

  Returns:
    Publisher
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setPublisher

     public void setPublisher(TagContent publisher) throws TagFormatException

  Set publisher, read from text content.

  Parameters:
    publisher - Publisher to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getTrack

     public TagContent getTrack() throws FrameDamagedException

  Read track number, store in text content.

  Returns:
    Track number
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setTrack

     public void setTrack(TagContent track) throws TagFormatException

  Set track number, read from text content.

  Parameters:
    track - Track number to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getRecordingDates

     public TagContent getRecordingDates() throws FrameDamagedException

  Get recording dates, store as text content

  Returns:
    Recording dates
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setRecordingDate

     public void setRecordingDate(TagContent date) throws TagFormatException

  Set recording date, read from text content.

  Parameters:
    date - Recording date
  Throws: TagFormatException
    If information to set is not correctly formatted

getInternetRadioStationName

     public TagContent getInternetRadioStationName() throws FrameDamagedException

  Get Internet radio station name, store as text content

  Returns:
    Internet radio station name
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setInternetRadioStationName

     public void setInternetRadioStationName(TagContent name) throws TagFormatException

  Set Internet radio station name, read from text content.

  Parameters:
    name - Internet radio station name
  Throws: TagFormatException
    If information to set is not correctly formatted

getInternetRadioStationOwner

     public TagContent getInternetRadioStationOwner() throws FrameDamagedException

  Get Internet radio station owner, store as text content

  Returns:
    Internet radio station owner
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setInternetRadioStationOwner

     public void setInternetRadioStationOwner(TagContent owner) throws TagFormatException

  Set Internet radio station owner, read from text content.

  Parameters:
    owner - Station owner
  Throws: TagFormatException
    If information to set is not correctly formatted

getFilesize

     public TagContent getFilesize() throws FrameDamagedException

  Get size of file in bytes, excluding id3v2 tag, store as text content

  Returns:
    Size of File
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setFilesize

     public void setFilesize(TagContent size) throws TagFormatException

  Set size of files in bytes, excluding id3v2 tag, read from text content.

  Parameters:
    size - Size of file
  Throws: TagFormatException
    If input is not numeric

getISRC

     public TagContent getISRC() throws FrameDamagedException

  Get International Standard Recording Code, store as text content

  Returns:
    ISRC
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setISRC

     public void setISRC(TagContent isrc) throws TagFormatException

  Set International Standard Recording Code, read from text content.

  Parameters:
    isrc - ISRC
  Throws: TagFormatException
    If input is not of 12 character's length

getYear

     public TagContent getYear() throws FrameDamagedException

  Get year of recording, store as text content

  Returns:
    Recording dates
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setYear

     public void setYear(TagContent year) throws TagFormatException

  Set year of recording, read from text content.

  Parameters:
    year - Year of recording
  Throws: TagFormatException
    If input is not numeric or not 4 or 5 characters

getCommercialInformation

     public TagContent getCommercialInformation() throws FrameDamagedException

  Read Commercial information webpage, store as text content

  Returns:
    Commercial information
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setCommercialInformation

     public void setCommercialInformation(TagContent info) throws TagFormatException

  Set Commercial information webpage, read from text content.

  Parameters:
    info - Commercial information to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getCopyrightWebpage

     public TagContent getCopyrightWebpage() throws FrameDamagedException

  Read Coypright / legal information webpage, store as text content

  Returns:
    Copyright webpage
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setCopyrightWebpage

     public void setCopyrightWebpage(TagContent copy) throws TagFormatException

  Set Copyright / legal information webpage, read from text content.

  Parameters:
    copy - Copyright webpage to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getAudioFileWebpage

     public TagContent getAudioFileWebpage() throws FrameDamagedException

  Read official audio file webpage, store as text content

  Returns:
    Audio file webpage
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setAudioFileWebpage

     public void setAudioFileWebpage(TagContent page) throws TagFormatException

  Set official audio file webpage, read from text content.

  Parameters:
    page - Official audio file webpage to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getArtistWebpage

     public TagContent getArtistWebpage() throws FrameDamagedException

  Read official artist / performer webpage, store as text content

  Returns:
    Artist webpage
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setArtistWebpage

     public void setArtistWebpage(TagContent page) throws TagFormatException

  Set official artist / performer webpage, read from text content.

  Parameters:
    page - Artist webpage webpage to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getAudioSourceWebpage

     public TagContent getAudioSourceWebpage() throws FrameDamagedException

  Read official audio source webpage, store as text content Used e.g. for movie soundtracks, then points to the movie

  Returns:
    Audio source webpage
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setAudioSourceWebpage

     public void setAudioSourceWebpage(TagContent page) throws TagFormatException

  Set official audio source webpage, read from text content.

  Parameters:
    page - Official audio source webpage to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getInternetRadioStationWebpage

     public TagContent getInternetRadioStationWebpage() throws FrameDamagedException

  Read official internet radio station webpage, store as text content

  Returns:
    Internet radio station webpage
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setInternetRadioStationWebpage

     public void setInternetRadioStationWebpage(TagContent page) throws TagFormatException

  Set official internet radio station webpage, read from text content.

  Parameters:
    page - Official internet radio station webpage to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getPaymentWebpage

     public TagContent getPaymentWebpage() throws FrameDamagedException

  Read payment webpage, store as text content

  Returns:
    Payment webpage
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setPaymentWebpage

     public void setPaymentWebpage(TagContent page) throws TagFormatException

  Set payment webpage, read from text content.

  Parameters:
    page - Payment webpage to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getPublishersWebpage

     public TagContent getPublishersWebpage() throws FrameDamagedException

  Read official publishers webpage, store as text content

  Returns:
    Publishers webpage
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setPublishersWebpage

     public void setPublishersWebpage(TagContent page) throws TagFormatException

  Set official publishers webpage, read from text content.

  Parameters:
    page - Official publishers webpage to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getEventTimingCodes

     public TagContent getEventTimingCodes() throws FrameDamagedException

  Read event timing codes, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Event timing codes
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setEventTimingCodes

     public void setEventTimingCodes(TagContent codes) throws TagFormatException

  Set event timing codes, read from binary content.

  Parameters:
    codes - Timing codes to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getLookupTable

     public TagContent getLookupTable() throws FrameDamagedException

  Read MPEG location lookup table, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Lookup table
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setLookupTable

     public void setLookupTable(TagContent table) throws TagFormatException

  Set MPEG location lookup table, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    table - Location lookup table to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getSynchronizedTempoCodes

     public TagContent getSynchronizedTempoCodes() throws FrameDamagedException

  Read synchronized tempo codes, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Synchronized tempo codes
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setSynchronizedTempoCodes

     public void setSynchronizedTempoCodes(TagContent codes) throws TagFormatException

  Set synchronized tempo codes, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    codes - Synchronized tempo codes to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getSynchronizedLyrics

     public TagContent getSynchronizedLyrics() throws FrameDamagedException

  Read synchronized lyrics, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Synchronized lyrics
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setSynchronizedLyrics

     public void setSynchronizedLyrics(TagContent lyrics) throws TagFormatException

  Set synchronized lyrics, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    lyrics - Synchronized lyrics
  Throws: TagFormatException
    If information to set is not correctly formatted

getRelativeVolumenAdjustment

     public TagContent getRelativeVolumenAdjustment() throws FrameDamagedException

  Read relative volume adjustment, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Relative volume adjustment
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setRelativeVolumeAdjustment

     public void setRelativeVolumeAdjustment(TagContent adjust) throws TagFormatException

  Set relative volume adjustment, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    adjust - Relative volume adjustment to set
  Throws: TagFormatException
    If information to set is not correctly formatted

getEqualisation

     public TagContent getEqualisation() throws FrameDamagedException

  Read equalisation, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Equalisation
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setEqualisation

     public void setEqualisation(TagContent equal) throws TagFormatException

  Set equalisation, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    equal - Equalisation
  Throws: TagFormatException
    If information to set is not correctly formatted

getReverb

     public TagContent getReverb() throws FrameDamagedException

  Read reverb, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Reverb
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setReverb

     public void setReverb(TagContent reverb) throws TagFormatException

  Set reverb, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    reverb - Reverb
  Throws: TagFormatException
    If information to set is not correctly formatted

getPlayCounter

     public TagContent getPlayCounter() throws FrameDamagedException

  Read play counter, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Play counter
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setPlayCounter

     public void setPlayCounter(TagContent count) throws TagFormatException

  Set play counter, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    count - Play counter
  Throws: TagFormatException
    If information to set is not correctly formatted

getPopularimeter

     public TagContent getPopularimeter() throws FrameDamagedException

  Read popularimeter, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Popularimeter
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setPopularimeter

     public void setPopularimeter(TagContent pop) throws TagFormatException

  Set popularimeter, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    pop - Popularimeter
  Throws: TagFormatException
    If information to set is not correctly formatted

getRecommendedBufferSize

     public TagContent getRecommendedBufferSize() throws FrameDamagedException

  Read recommended buffer size, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Recommended buffer size
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setRecommendedBufferSize

     public void setRecommendedBufferSize(TagContent size) throws TagFormatException

  Set recommended buffer size, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    size - Recommended buffer size
  Throws: TagFormatException
    If information to set is not correctly formatted

getPositionSynchronization

     public TagContent getPositionSynchronization() throws FrameDamagedException

  Read position synchronization, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Position synchronization
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setPositionSynchronization

     public void setPositionSynchronization(TagContent synch) throws TagFormatException

  Set position synchronization, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    synch - Position synchronization
  Throws: TagFormatException
    If information to set is not correctly formatted

getOwnership

     public TagContent getOwnership() throws FrameDamagedException

  Read ownership, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Ownership
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setOwnership

     public void setOwnership(TagContent owner) throws TagFormatException

  Set ownership, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    owner - Ownership
  Throws: TagFormatException
    If information to set is not correctly formatted

getCommercial

     public TagContent getCommercial() throws FrameDamagedException

  Read commercial frame, store as binary content See the ID3v2 informal standard for details on the format of this field.

  Returns:
    Commercial frame
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setCommercial

     public void setCommercial(TagContent commercial) throws TagFormatException

  Set commercial frame, read from binary content. See the ID3v2 informal standard for details on the format of this field.

  Parameters:
    commercial - Commercial frame
  Throws: TagFormatException
    If information to set is not correctly formatted

getCDIdentifier

     public TagContent getCDIdentifier() throws FrameDamagedException

  Read Music CD identifier, store as binary content

  Returns:
    Music CD identifier
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setCDIdentifier

     public void setCDIdentifier(TagContent ident) throws TagFormatException

  Set music CD identifier, read from binary content.

  Parameters:
    ident - CD identifier
  Throws: TagFormatException
    If information to set is not correctly formatted

getUniqueFileIdentifier

     public TagContent getUniqueFileIdentifier() throws FrameDamagedException

  Read unique file identifier. Owner identifier is stored as description, identifier as binary content.

  Returns:
    Unique file identifier
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setUniqueFileIdentifier

     public void setUniqueFileIdentifier(TagContent ufi) throws TagFormatException

  Set unique file identifier. Owner identifier is read from description, identifier from binary content.

  Parameters:
    ufi - Unique file identifier to set.
  Throws: TagFormatException
    If File identifier is longer than 64 characters

getUserDefinedText

     public TagContent getUserDefinedText() throws FrameDamagedException

  Read user defined text, store description as description and value as text content

  Returns:
    User defined text
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setUserDefinedText

     public void setUserDefinedText(TagContent info) throws TagFormatException

  Set user defined text information. Description is read from description, value from text content.

  Parameters:
    info - User defined text information
  Throws: TagFormatException
    If information to set is not correctly formatted

getUserDefinedURL

     public TagContent getUserDefinedURL() throws FrameDamagedException

  Read user defined URL, store description as description and URL as text content

  Returns:
    User defined URL link
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setUserDefinedURL

     public void setUserDefinedURL(TagContent link) throws TagFormatException

  Set user defined URL link. Description is read from description, URL from text content.

  Parameters:
    link - User defined URL link
  Throws: TagFormatException
    If information to set is not correctly formatted

getUnsynchronizedLyrics

     public TagContent getUnsynchronizedLyrics() throws FrameDamagedException

  Read unsynchronized lyrics, store language as type, description as description and lyrics as text content

  Returns:
    Unsynchronized lyrics
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setUnsynchronizedLyrics

     public void setUnsynchronizedLyrics(TagContent lyric) throws TagFormatException

  Set unsynchronized lyrics. Language is read from type, Description from description, lyrics from text content.

  Parameters:
    lyric - Unsynchronized lyrics
  Throws: TagFormatException
    If information to set is not correctly formatted

getComments

     public TagContent getComments() throws FrameDamagedException

  Read comments, store language as type, description as description and comments as text content

  Returns:
    Comments
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setComments

     public void setComments(TagContent comm) throws TagFormatException

  Set comments. Language is read from type, Description from description, comments from text content.

  Parameters:
    comm - Comments
  Throws: TagFormatException
    If information to set is not correctly formatted

getPicture

     public TagContent getPicture() throws FrameDamagedException

  Read attached picture, store MIME type as type, picture type as binary subtype, description as description and picture data as binary content.

  Returns:
    Picture
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setPicture

     public void setPicture(TagContent pic) throws TagFormatException

  Set attached picture. MIME type is read from type, picture type from binary subtype, description from description, picture data from binary content.

  Parameters:
    pic - Picture
  Throws: TagFormatException
    If information to set is not correctly formatted

getEncapsulatedObject

     public TagContent getEncapsulatedObject() throws FrameDamagedException

  Read general encapsulated object, store MIME type as type, filename as text subtype, description as description and object as binary content.

  Returns:
    Object
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setEncapsulatedObject

     public void setEncapsulatedObject(TagContent obj) throws TagFormatException

  Set general encapsulated object. MIME type is read from type, filename from subtype, description from description, object from binary content.

  Parameters:
    obj - Object
  Throws: TagFormatException
    If information to set is not correctly formatted

getTermsOfUse

     public TagContent getTermsOfUse() throws FrameDamagedException

  Read terms of use, store language as type and terms of use as text content

  Returns:
    Terms of use
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setTermsOfUse

     public void setTermsOfUse(TagContent use) throws TagFormatException

  Set terms of use. Language is read from type, terms of use from text content.

  Parameters:
    use - Terms of use
  Throws: TagFormatException
    If information to set is not correctly formatted

getEncryptionMethodRegistration

     public TagContent getEncryptionMethodRegistration() throws FrameDamagedException

  Read encryption method registration, store owner identifier as type, method symbol as binary subtype and encryption data as binary content.

  Returns:
    Encryption method registration
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setEncryptionMethodRegistration

     public void setEncryptionMethodRegistration(TagContent encr) throws TagFormatException

  Set encryption method registration. Owner identifier is read from type, method symbol from binary subtype and encryption data from binary content.

  Parameters:
    encr - Encryption method
  Throws: TagFormatException
    If information to set is not correctly formatted

getGroupIdentificationRegistration

     public TagContent getGroupIdentificationRegistration() throws FrameDamagedException

  Read group identification registration, store owner identifier as type, group symbol as binary subtype and group dependent data as binary content.

  Returns:
    Group identification registration
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setGroupIdentificationRegistration

     public void setGroupIdentificationRegistration(TagContent grp) throws TagFormatException

  Set group identification registration. Owner identifier is read from type, group symbol from binary subtype and group dependent data from binary content.

  Parameters:
    grp - Group identification
  Throws: TagFormatException
    If information to set is not correctly formatted

getPrivateData

     public TagContent getPrivateData() throws FrameDamagedException

  Read private data, store owner identifier as type, private data as binary content.

  Returns:
    Private data
  Throws: FrameDamagedException
    If frame is damaged (e.g. too short)

setPrivateData

     public void setPrivateData(TagContent data) throws TagFormatException

  Set private data. Owner identifier is read from type, private data from binary content.

  Parameters:
    data - Private data
  Throws: TagFormatException
    If information to set is not correctly formatted

    All Packages  Class Hierarchy  This Package  Previous  Next  Index