public class TagOptionSingleton extends Object
Modifier and Type | Method and Description |
---|---|
void |
addKeyword(Class<? extends ID3v24FrameBody> id3v2FrameBodyClass,
String keyword) |
void |
addParenthesis(String open,
String close) |
void |
addReplaceWord(String oldWord,
String newWord) |
byte |
getId3v23DefaultTextEncoding()
Get the default text encoding to use for new v23 frames, when unicode is required
UTF16 will always be used because that is the only valid option for v23/v22
|
byte |
getId3v24DefaultTextEncoding()
Get the default text encoding to use for new v24 frames, it defaults to simple ISO8859
but by changing this value you could always used UTF8 for example whether you needed to or not
|
byte |
getId3v24UnicodeTextEncoding()
Get the text encoding to use for new v24 frames when unicode is required, it defaults to UTF16 just
because this encoding is understand by all ID3 versions
|
ID3V2Version |
getID3V2Version() |
static TagOptionSingleton |
getInstance() |
static TagOptionSingleton |
getInstance(String instanceKey) |
static String |
getInstanceKey() |
Iterator<Class<? extends ID3v24FrameBody>> |
getKeywordIterator() |
Iterator<String> |
getKeywordListIterator(Class<? extends ID3v24FrameBody> id3v2_4FrameBody) |
String |
getLanguage()
Returns the default language for any ID3v2 tag frames which require it.
|
boolean |
getLyrics3SaveField(String id)
Returns true if we should save the Lyrics3 field asked for in the
argument.
|
HashMap<String,Boolean> |
getLyrics3SaveFieldMap() |
String |
getNewReplaceWord(String oldWord) |
int |
getNumberMP3SyncFrame()
Returns the number of MP3 frames to sync when trying to find the start
of the MP3 frame data.
|
Iterator<String> |
getOldReplaceWordIterator() |
Iterator<String> |
getOpenParenthesisIterator() |
PadNumberOption |
getPadNumberTotalLength()
Total length of number, i.e if set to 2 the value 1 would be stored as 01, if set to 3 would bs stored as 001
|
int |
getPlayerCompatability()
When this is set and using the generic interface jaudiotagger will make some adjustmensts
when saving field sso they work best with the specified Tagger
|
byte |
getTimeStampFormat()
Returns the default time stamp format for ID3v2 tags which require it.
|
VorbisAlbumArtistReadOptions |
getVorbisAlbumArtisReadOptions() |
VorbisAlbumArtistSaveOptions |
getVorbisAlbumArtistSaveOptions() |
WavOptions |
getWavOptions() |
WavSaveOptions |
getWavSaveOptions() |
WavSaveOrder |
getWavSaveOrder() |
long |
getWriteChunkSize()
When we have to create new audio files and shift audio data to fit in more metadata this value
set the maximum amount in bytes that can be transferred in one call, this is to protect against
various OutOfMemoryExceptions that cna occur, especially on networked filesystems.
|
boolean |
isAndroid() |
boolean |
isAPICDescriptionITunesCompatible()
Itunes expects APIC description to be encoded as ISO-8859-1 even if text encoding is set to 1 (UTF16)
|
boolean |
isCheckIsWritable()
Whether Files.isWritable should be used to check if a file can be written.
|
boolean |
isEncodeUTF16BomAsLittleEndian()
When you specify a field should be stored as UTF16 in ID3 this means write with BOM indicating whether
written as Little Endian or Big Endian, its defaults to little Endian
|
boolean |
isFilenameTagSave() |
boolean |
isId3v1Save() |
boolean |
isId3v1SaveAlbum() |
boolean |
isId3v1SaveArtist() |
boolean |
isId3v1SaveComment() |
boolean |
isId3v1SaveGenre() |
boolean |
isId3v1SaveTitle() |
boolean |
isId3v1SaveTrack() |
boolean |
isId3v1SaveYear() |
boolean |
isId3v2ITunes12_6WorkGroupingMode() |
boolean |
isId3v2PaddingCopyTag() |
boolean |
isId3v2PaddingWillShorten() |
boolean |
isId3v2Save() |
boolean |
isLyrics3KeepEmptyFieldIfRead() |
boolean |
isLyrics3Save() |
boolean |
isLyrics3SaveEmptyField() |
boolean |
isOpenParenthesis(String open) |
boolean |
isOriginalSavedAfterAdjustingID3v2Padding() |
boolean |
isPadNumbers() |
boolean |
isPreserveFileIdentity()
If set to
true , when writing, make an attempt to overwrite the existing file in-place
instead of first moving it out of the way and moving a temp file into its place. |
boolean |
isRemoveTrailingTerminatorOnWrite()
Do we remove unnecessary trailing null characters on write
|
boolean |
isResetTextEncodingForExistingFrames()
When writing frames if this is set to true then the frame will be written
using the defaults disregarding the text encoding originally used to create
the frame.
|
boolean |
isTruncateTextWithoutErrors() |
boolean |
isUnsyncTags() |
boolean |
isWriteMp3GenresAsText()
If enabled we always use the ©gen atom rather than the gnre atom when writing genres to mp4s
This is known to help some android apps
|
boolean |
isWriteMp4GenresAsText()
If enabled we always use the ©gen atom rather than the gnre atom when writing genres to mp4s
This is known to help some android apps
|
boolean |
isWriteWavForTwonky() |
void |
setAndroid(boolean android) |
void |
setAPICDescriptionITunesCompatible(boolean APICDescriptionITunesCompatible) |
void |
setCheckIsWritable(boolean checkIsWritable) |
void |
setEncodeUTF16BomAsLittleEndian(boolean encodeUTF16BomAsLittleEndian) |
void |
setFilenameTagSave(boolean filenameTagSave) |
void |
setId3v1Save(boolean id3v1Save) |
void |
setId3v1SaveAlbum(boolean id3v1SaveAlbum) |
void |
setId3v1SaveArtist(boolean id3v1SaveArtist) |
void |
setId3v1SaveComment(boolean id3v1SaveComment) |
void |
setId3v1SaveGenre(boolean id3v1SaveGenre) |
void |
setId3v1SaveTitle(boolean id3v1SaveTitle) |
void |
setId3v1SaveTrack(boolean id3v1SaveTrack) |
void |
setId3v1SaveYear(boolean id3v1SaveYear) |
void |
setId3v23DefaultTextEncoding(byte id3v23DefaultTextEncoding)
Set the default text encoding to use for new v23 frames, when unicode is required
UTF16 will always be used because that is the only valid option for v23/v22
|
void |
setId3v24DefaultTextEncoding(byte id3v24DefaultTextEncoding)
Set the default text encoding to use for new v24 frames, it defaults to simple ISO8859
but by changing this value you could always used UTF8 for example whether you needed to or not
|
void |
setId3v24UnicodeTextEncoding(byte id3v24UnicodeTextEncoding)
Set the text encoding to use for new v24 frames when unicode is required, it defaults to UTF16 just
because this encoding is understand by all ID3 versions
|
void |
setId3v2ITunes12_6WorkGroupingMode(boolean id3v2ITunes12_6WorkGroupingMode)
Special work/grouping mode for iTunes 12.6.
|
void |
setId3v2PaddingCopyTag(boolean id3v2PaddingCopyTag) |
void |
setId3v2PaddingWillShorten(boolean id3v2PaddingWillShorten) |
void |
setId3v2Save(boolean id3v2Save) |
void |
setID3V2Version(ID3V2Version id3v2Version) |
void |
setInstanceKey(String instanceKey) |
void |
setLanguage(String lang)
Sets the default language for any ID3v2 tag frames which require it.
|
void |
setLyrics3KeepEmptyFieldIfRead(boolean lyrics3KeepEmptyFieldIfRead) |
void |
setLyrics3Save(boolean lyrics3Save) |
void |
setLyrics3SaveEmptyField(boolean lyrics3SaveEmptyField) |
void |
setLyrics3SaveField(String id,
boolean save)
Sets if we should save the Lyrics3 field.
|
void |
setNumberMP3SyncFrame(int numberMP3SyncFrame)
Sets the number of MP3 frames to sync when trying to find the start of
the MP3 frame data.
|
void |
setOriginalSavedAfterAdjustingID3v2Padding(boolean originalSavedAfterAdjustingID3v2Padding) |
void |
setPadNumbers(boolean padNumbers) |
void |
setPadNumberTotalLength(PadNumberOption padNumberTotalLength) |
void |
setPlayerCompatability(int playerCompatability) |
void |
setPreserveFileIdentity(boolean preserveFileIdentity)
If set to
true , when writing, make an attempt to preserve the file identity. |
void |
setRemoveTrailingTerminatorOnWrite(boolean removeTrailingTerminatorOnWrite)
Remove unnecessary trailing null characters on write
|
void |
setResetTextEncodingForExistingFrames(boolean resetTextEncodingForExistingFrames)
When writing frames if this is set to true then the frame will be written
using the defaults disregarding the text encoding originally used to create
the frame.
|
void |
setTimeStampFormat(byte tsf)
Sets the default time stamp format for ID3v2 tags which require it.
|
void |
setToDefault() |
void |
setTruncateTextWithoutErrors(boolean truncateTextWithoutErrors)
Set truncate without errors
|
void |
setUnsyncTags(boolean unsyncTags)
Unsync tag where necessary, currently only applies to IDv23
|
void |
setVorbisAlbumArtistReadOptions(VorbisAlbumArtistReadOptions vorbisAlbumArtistReadOptions) |
void |
setVorbisAlbumArtistSaveOptions(VorbisAlbumArtistSaveOptions vorbisAlbumArtistSaveOptions) |
void |
setWavOptions(WavOptions wavOptions) |
void |
setWavSaveOptions(WavSaveOptions wavSaveOptions) |
void |
setWavSaveOrder(WavSaveOrder wavSaveOrder) |
void |
setWriteChunkSize(long writeChunkSize) |
void |
setWriteMp3GenresAsText(boolean writeMp3GenresAsText) |
void |
setWriteMp4GenresAsText(boolean writeMp4GenresAsText) |
void |
setWriteWavForTwonky(boolean isWriteWavForTwonky) |
public void setWavOptions(WavOptions wavOptions)
public WavOptions getWavOptions()
public void setWavSaveOptions(WavSaveOptions wavSaveOptions)
public WavSaveOptions getWavSaveOptions()
public void setWavSaveOrder(WavSaveOrder wavSaveOrder)
public WavSaveOrder getWavSaveOrder()
public void setVorbisAlbumArtistSaveOptions(VorbisAlbumArtistSaveOptions vorbisAlbumArtistSaveOptions)
public VorbisAlbumArtistSaveOptions getVorbisAlbumArtistSaveOptions()
public void setVorbisAlbumArtistReadOptions(VorbisAlbumArtistReadOptions vorbisAlbumArtistReadOptions)
public VorbisAlbumArtistReadOptions getVorbisAlbumArtisReadOptions()
public static TagOptionSingleton getInstance()
public static TagOptionSingleton getInstance(String instanceKey)
instanceKey
- public void setFilenameTagSave(boolean filenameTagSave)
filenameTagSave
- public boolean isFilenameTagSave()
public void setID3V2Version(ID3V2Version id3v2Version)
id3v2Version
- public ID3V2Version getID3V2Version()
public void setInstanceKey(String instanceKey)
instanceKey
- public static String getInstanceKey()
public void setId3v1Save(boolean id3v1Save)
id3v1Save
- public boolean isId3v1Save()
public void setId3v1SaveAlbum(boolean id3v1SaveAlbum)
id3v1SaveAlbum
- public boolean isId3v1SaveAlbum()
public void setId3v1SaveArtist(boolean id3v1SaveArtist)
id3v1SaveArtist
- public boolean isId3v1SaveArtist()
public void setId3v1SaveComment(boolean id3v1SaveComment)
id3v1SaveComment
- public boolean isId3v1SaveComment()
public void setId3v1SaveGenre(boolean id3v1SaveGenre)
id3v1SaveGenre
- public boolean isId3v1SaveGenre()
public void setId3v1SaveTitle(boolean id3v1SaveTitle)
id3v1SaveTitle
- public boolean isId3v1SaveTitle()
public void setId3v1SaveTrack(boolean id3v1SaveTrack)
id3v1SaveTrack
- public boolean isId3v1SaveTrack()
public void setId3v1SaveYear(boolean id3v1SaveYear)
id3v1SaveYear
- public boolean isId3v1SaveYear()
public void setId3v2PaddingCopyTag(boolean id3v2PaddingCopyTag)
id3v2PaddingCopyTag
- public boolean isId3v2PaddingCopyTag()
public void setId3v2PaddingWillShorten(boolean id3v2PaddingWillShorten)
id3v2PaddingWillShorten
- public boolean isId3v2PaddingWillShorten()
public void setId3v2Save(boolean id3v2Save)
id3v2Save
- public boolean isId3v2Save()
public boolean isId3v2ITunes12_6WorkGroupingMode()
public void setId3v2ITunes12_6WorkGroupingMode(boolean id3v2ITunes12_6WorkGroupingMode)
Special work/grouping mode for iTunes 12.6.
If true
, map
FieldKey.WORK
to FrameBodyTIT1
and FieldKey.GROUPING
to FrameBodyGRP1
.
If false
, map
FieldKey.WORK
to special FrameBodyTXXX
and FieldKey.GROUPING
to FrameBodyTIT1
.
The latter used to be the default behavior before iTunes 12.6.
id3v2ITunes12_6WorkGroupingMode
- true
or false
.public Iterator<Class<? extends ID3v24FrameBody>> getKeywordIterator()
public Iterator<String> getKeywordListIterator(Class<? extends ID3v24FrameBody> id3v2_4FrameBody)
id3v2_4FrameBody
- public void setLanguage(String lang)
lang
- language ID, [ISO-639-2] ISO/FDIS 639-2 definitionpublic String getLanguage()
public void setLyrics3KeepEmptyFieldIfRead(boolean lyrics3KeepEmptyFieldIfRead)
lyrics3KeepEmptyFieldIfRead
- public boolean isLyrics3KeepEmptyFieldIfRead()
public void setLyrics3Save(boolean lyrics3Save)
lyrics3Save
- public boolean isLyrics3Save()
public void setLyrics3SaveEmptyField(boolean lyrics3SaveEmptyField)
lyrics3SaveEmptyField
- public boolean isLyrics3SaveEmptyField()
public void setLyrics3SaveField(String id, boolean save)
id
- Lyrics3 id stringsave
- true if you want to save this specific Lyrics3 field.public boolean getLyrics3SaveField(String id)
id
- Lyrics3 id stringpublic void setNumberMP3SyncFrame(int numberMP3SyncFrame)
numberMP3SyncFrame
- number of MP3 frames to syncpublic int getNumberMP3SyncFrame()
public boolean isOpenParenthesis(String open)
open
- public void setOriginalSavedAfterAdjustingID3v2Padding(boolean originalSavedAfterAdjustingID3v2Padding)
originalSavedAfterAdjustingID3v2Padding
- public boolean isOriginalSavedAfterAdjustingID3v2Padding()
public void setTimeStampFormat(byte tsf)
tsf
- the new default time stamp formatpublic byte getTimeStampFormat()
public void setToDefault()
public void addKeyword(Class<? extends ID3v24FrameBody> id3v2FrameBodyClass, String keyword) throws TagException
id3v2FrameBodyClass
- keyword
- TagException
public void addReplaceWord(String oldWord, String newWord)
oldWord
- newWord
- public boolean isUnsyncTags()
public void setUnsyncTags(boolean unsyncTags)
unsyncTags
- set whether tags are unsynchronized when written if contain bit pattern that could
be mistaken for audio markerpublic boolean isRemoveTrailingTerminatorOnWrite()
public void setRemoveTrailingTerminatorOnWrite(boolean removeTrailingTerminatorOnWrite)
removeTrailingTerminatorOnWrite
- public byte getId3v23DefaultTextEncoding()
public void setId3v23DefaultTextEncoding(byte id3v23DefaultTextEncoding)
id3v23DefaultTextEncoding
- public byte getId3v24DefaultTextEncoding()
public void setId3v24DefaultTextEncoding(byte id3v24DefaultTextEncoding)
id3v24DefaultTextEncoding
- public byte getId3v24UnicodeTextEncoding()
public void setId3v24UnicodeTextEncoding(byte id3v24UnicodeTextEncoding)
id3v24UnicodeTextEncoding
- public boolean isResetTextEncodingForExistingFrames()
public void setResetTextEncodingForExistingFrames(boolean resetTextEncodingForExistingFrames)
resetTextEncodingForExistingFrames
- public boolean isTruncateTextWithoutErrors()
public void setTruncateTextWithoutErrors(boolean truncateTextWithoutErrors)
truncateTextWithoutErrors
- public boolean isPadNumbers()
public void setPadNumbers(boolean padNumbers)
public boolean isAndroid()
public void setAndroid(boolean android)
public int getPlayerCompatability()
public void setPlayerCompatability(int playerCompatability)
public boolean isEncodeUTF16BomAsLittleEndian()
public void setEncodeUTF16BomAsLittleEndian(boolean encodeUTF16BomAsLittleEndian)
public long getWriteChunkSize()
public void setWriteChunkSize(long writeChunkSize)
public boolean isWriteMp4GenresAsText()
public void setWriteMp4GenresAsText(boolean writeMp4GenresAsText)
public boolean isWriteMp3GenresAsText()
public void setWriteMp3GenresAsText(boolean writeMp3GenresAsText)
public PadNumberOption getPadNumberTotalLength()
public void setPadNumberTotalLength(PadNumberOption padNumberTotalLength)
public boolean isAPICDescriptionITunesCompatible()
public void setAPICDescriptionITunesCompatible(boolean APICDescriptionITunesCompatible)
public boolean isCheckIsWritable()
public void setCheckIsWritable(boolean checkIsWritable)
public boolean isPreserveFileIdentity()
If set to true
, when writing, make an attempt to overwrite the existing file in-place
instead of first moving it out of the way and moving a temp file into its place.
Preserving the file identity has the advantage of preserving the creation time as well as the Unix inode or Windows fileIndex.
true
or false
. Default is false
.public void setPreserveFileIdentity(boolean preserveFileIdentity)
true
, when writing, make an attempt to preserve the file identity.preserveFileIdentity
- true
or false
isPreserveFileIdentity()
public boolean isWriteWavForTwonky()
public void setWriteWavForTwonky(boolean isWriteWavForTwonky)
Copyright © 2005–2020 jthink.net. All rights reserved.