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

Constructor Index

 o MP3File(File, String)
Creates a MP3File instance that represents the file with the specified name in the specified directory.
 o MP3File(String)
Creates a new instance.
 o 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.

Method Index

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

Musical key in which sound starts.

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

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

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

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

Constructors

 o 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
 o 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
 o 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

Methods

 o 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
 o setWriteID3
 public void setWriteID3(boolean write_id3)
Write ID3 tag?

Parameters:
write_id3 - True: Write ID3 tag on update
 o getWriteID3
 public boolean getWriteID3()
Should an ID3 tag be written

Returns:
true if ID3 tag will be written on update
 o setWriteID3v2
 public void setWriteID3v2(boolean write_id3v2)
Write ID3v2 tag?

Parameters:
write_id3v2 - True: Write ID3v2 tag on update
 o getWriteID3v2
 public boolean getWriteID3v2()
Should an ID3v2 tag be written?

Returns:
true if ID3v2 tag will be written on update
 o 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
 o getUseCompression
 public boolean getUseCompression()
Returns:
true if compression will be used in ID3v2 tag
 o setUseCRC
 public void setUseCRC(boolean use_crc)
Use CRC in ID3v2 tag?

Parameters:
use_crc - True: Use CRC
 o getUseCRC
 public boolean getUseCRC()
Returns:
true if CRC will be used in ID3v2 tag
 o setUsePadding
 public void setUsePadding(boolean use_padding)
Use padding in ID3v2 tag?

Parameters:
use_padding - True: Use padding
 o getUsePadding
 public boolean getUsePadding()
Returns:
true if padding will be used in ID3v2 tag
 o setUseUnsynchronization
 public void setUseUnsynchronization(boolean use_unsynch)
Use unsynchronization in ID3v2 tag?

Parameters:
use_unsynch - True: Use unsynchronization
 o getUseUnsynchronization
 public boolean getUseUnsynchronization()
Returns:
true if unsynchronization will be used in ID3v2 tag
 o getMPEGLevel
 public int getMPEGLevel()
Returns:
MPEG level (1 or 2)
 o getLayer
 public int getLayer()
Returns:
Layer (1..3)
 o getBitrate
 public int getBitrate()
Returns:
Bitrate
 o getSamplerate
 public int getSamplerate()
Returns:
Samplerate
 o getMode
 public int getMode()
Returns mode (mono, stereo, etc.) used in MP3 file Better use constants from MP3Properties.

Returns:
Mode
 o getEmphasis
 public int getEmphasis()
Returns emphasis used in MP3 file Better use constants from MP3Properties.

Returns:
Emphasis
 o getProtection
 public boolean getProtection()
Returns:
Protection (CRC) set
 o getPrivate
 public boolean getPrivate()
Returns:
Private bit set?
 o getPadding
 public boolean getPadding()
Returns:
Padding set?
 o getCopyright
 public boolean getCopyright()
Returns:
Copyright set?
 o getOriginal
 public boolean getOriginal()
Returns:
Original?
 o getLength
 public long getLength()
Returns:
Length in seconds
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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.
 o 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)
 o 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
 o 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)
 o 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
 o getLyricist
 public TagContent getLyricist() throws FrameDamagedException
Read lyricist, store as text content.

Returns:
Lyricist
Throws: FrameDamagedException
If frame is damaged (e.g. too short)
 o 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
 o getFileType
 public TagContent getFileType() throws FrameDamagedException
Read file type, store as text content.

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

Returns:
File type
Throws: FrameDamagedException
If frame is damaged (e.g. too short)
 o 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
 o 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)
 o 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.
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o getArtist
 public TagContent getArtist() throws FrameDamagedException
Read artist, store as text content.

Returns:
Artist
Throws: FrameDamagedException
If frame is damaged (e.g. too short)
 o 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
 o 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)
 o 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
 o getConductor
 public TagContent getConductor() throws FrameDamagedException
Read conductor, store as text content

Returns:
Conductor
Throws: FrameDamagedException
If frame is damaged (e.g. too short)
 o 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
 o getRemixer
 public TagContent getRemixer() throws FrameDamagedException
Read remixer, store as text content

Returns:
Remixer
Throws: FrameDamagedException
If frame is damaged (e.g. too short)
 o 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
 o 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)
 o 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
 o getPublisher
 public TagContent getPublisher() throws FrameDamagedException
Read publisher, store as text content

Returns:
Publisher
Throws: FrameDamagedException
If frame is damaged (e.g. too short)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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
 o 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)
 o 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