Class Song
- java.lang.Object
-
- com.tagtraum.beatunes.library.Song
-
- All Implemented Interfaces:
AudioSong
,Matchable<PlayList.SubstringFilterProperty>
,Serializable
@Entity public class Song extends Object implements Matchable<PlayList.SubstringFilterProperty>, Serializable, AudioSong
Song object that represents song data in beaTunes' own database, theMediaLibrary
. Modifications to instances have to persisted by calling e.g.MediaLibrary.store(AudioSong, String)
. Storing modifications in beaTunes' database does not automatically store those modifications in iTunes or the audio file. SeeTrack
. Some methods only act as facade forSongAnnotation
.- Author:
- Hendrik Schreiber
- See Also:
SongAnnotation
, Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.tagtraum.audiokern.AudioSong
AudioSong.CloudStatus, AudioSong.Instrumentation, AudioSong.Liking, AudioSong.MediaKind, AudioSong.TrackType
-
-
Field Summary
-
Fields inherited from interface com.tagtraum.audiokern.AudioSong
ACOUSTIC_NAMES, ELECTRONIC_NAMES
-
-
Constructor Summary
Constructors Constructor Description Song()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addArtwork(AudioArtwork audioArtwork)
Adds an artwork/image to the audio song.void
addPropertyChangeListener(PropertyChangeListener propertyChangeListener)
Lets you add a property change listener to this song.void
addPropertyChangeListener(String property, PropertyChangeListener propertyChangeListener)
Lets you add a property change listener to this song.boolean
canWrite()
Checks whether the file corresponding to this song can in principal be written to.SongAnnotation
createSongAnnotation()
Creates and associates aSongAnnotation
with this Song, if no annotation exists yet.void
download()
Allows downloading of shared (e.g.boolean
equals(Object obj)
String
getAlbum()
Get Album.String
getAlbumArtist()
Get album artist.Set<AudioId>
getAlbumIds()
Get album ids.AudioSong.Liking
getAlbumLiking()
Is album liked.int
getAlbumRating()
Get album rating.ReplayGain
getAlbumReplayGain()
Replay gain for this album.String
getArtist()
Get artist.Set<AudioId>
getArtistIds()
Get artists ids.int
getArtworkCount()
Get artwork count.AudioArtwork[]
getArtworks()
Artwork belonging to this song.AudioMetaData
getAudioMetaData()
Gets some audio meta data for this song from the actual file.AudioMetaData
getAudioMetaData(boolean fresh)
Gets some audio meta data for this song from the actual file.Image
getBackCoverImage()
Returns the first front cover image.Beats
getBeats()
The song's beats.String
getBeatsAlgorithm()
Method the beats were computed with.float
getBeatsPerMinute()
Beats per minute (BPM).String
getBeatsPerMinuteAlgorithm()
Returns the name of the algorithm used to determine the beats per minute (BPM).int
getBitRate()
Bit rate.AudioSong.CloudStatus
getCloudStatus()
Returns the cloud status, if available.Color
getColor()
Returns the color.String
getComments()
Get comments.String
getComposer()
Get composer(s).String
getContentRating()
Returns the content rating.String
getCustom1()
Custom field.String
getCustom2()
Custom field.String
getCustom3()
Custom field.String
getCustom4()
Custom field.String
getCustom5()
Custom field.Float
getDanceability()
Danceability.String
getDanceabilityAlgorithm()
Returns the name of the danceability algorithm.Date
getDateAdded()
Get date the song was added to the library.Date
getDateAnalyzed()
Date the song was last analyzed.Date
getDateModified()
Get date of last modification.String
getDescription()
Description/subtitle of this song.int
getDiscCount()
Assuming that this song is on a disc that is part of a disc collection, return the number of discs in this collection.int
getDiscNumber()
Get the disc number.String
getEpisode()
Get episode name.int
getEpisodeOrder()
Episode order.String
getEqualizer()
Path
getFile(boolean refresh)
File of this track.int
getFileCreator()
int
getFileFolderCount()
int
getFileType()
byte[]
getFingerprint()
Acoustic fingerprint.float
getFinish()
Stop time of the song in seconds.Image
getFrontCoverImage()
Returns the first front cover image.String
getGenre()
Get genre.String
getGrouping()
Get grouping.Long
getId()
Persistent id.Image
getImage()
First artwork image.Image[]
getImages()
All images.<T> T
getImplementation(Class<T> klass)
AudioSong
objects are sometimes implemented by an object that acts as a facade to other AudioSong objects.List<AudioSong>
getImplementations()
Returns implementations of this interface instance.AudioSong.Instrumentation
getInstrumentation()
Indicates whether this song qualifies as "electronic" or "acoustic".String
getInstrumentationAlgorithm()
Returns the name of the instrumentation algorithm.int
getITunesPropertiesHashCode()
Hash code for the iTunes parts of this song.Key
getKey()
Return the tonal key of this song.String
getKeyAlgorithm()
Returns the name of the key algorithm.String
getKind()
Kind of audio, e.g.String
getLanguage()
The language of the lyrics as ISO 639 three letter codes.int
getLibraryFolderCount()
AudioSong.Liking
getLiking()
Liking.String
getLocation(boolean refresh)
Location of this track.Loudness
getLoudness()
The song's loudness curve.String
getLyrics()
Returns the lyrics.List<TermFrequency>
getLyricsTermFrequencies()
Terms in this song's lyrics along with their frequency.float
getMeasuresPerMinute()
Measures (bars) per minute.AudioSong.MediaKind
getMediaKind()
Media kind of this object.Mood
getMood()
The song's mood.String
getMoodAlgorithm()
The method the associated mood value was created with.Set<String>
getMoodKeywords()
Get raw mood keywords.String
getMovement()
Classical movement.int
getMovementCount()
Classical movement count.int
getMovementNumber()
Classical movement number.String
getName()
Name of this song.String
getPath()
Path.int
getPlayCount()
Get the number of times the song was played.long
getPlayDate()
Get time the song was last played.Date
getPlayDateUTC()
Get play date.double
getPlayFrequency()
Played per 100 days.Long
getPlaylistId()
The id of the playlist this song object stems from.Collection<PlayList>
getPlayLists()
Returns playlists the song belongs to.double
getPlaySkipRatio()
Play/Skip ratio.float
getPopularity()
Popularity as a value between 0 and 1.PropertyChangeListener[]
getPropertyChangeListeners()
PropertyChangeListener[]
getPropertyChangeListeners(String property)
int
getRating()
Value ranging from 0-100, 100 being best.Float
getRelativeSpectralEntropyMean()
Average of relative entropy values computed for windows of length 1.486s with a hopsize of half a window.Date
getReleaseDate()
Release year (corresponds to id3 TDRL).int
getReleaseYear()
float
getRemoteDisliked()
Indicates, what percentage of people "dislike" this song.float
getRemoteLoved()
Indicates, what percentage of people "love" this song.float
getRemotePlayFrequency()
Average of play frequencies as reported by users.float
getRemotePlaySkipRatio()
Play/skip ratio by all users with this song.int
getRemoteRating()
Average of other people's ratings.Date
getRemoteUpdateDate()
Time the remote properties of this song were last updated.Float
getRMSMean()
Root mean square (RMS) of the signal's energy, averaged over windows of length ~23ms (actually 1024/44100 frames for a signal with sample rate 44.1kHz, i.e.Float
getRMSStandardDeviation()
Standard deviation of the root mean square energy values for windows of length ~23ms (actually 1024/44100 frames for a signal with sample rate 44.1kHz) with a hopsize of half a window.int
getSampleRate()
Get sample rate in Hz.int
getSeason()
Get season number.Segments
getSegments()
The song's segments.String
getSegmentsAlgorithm()
Method the segments were computed with.String
getShow()
Name of a show, suitable for TV shows.Similarities
getSimilarities()
The song's similarities.String
getSimilaritiesAlgorithm()
Method the similarities were computed with.long
getSize()
File size.int
getSkipCount()
Get skip count.Date
getSkipDate()
Get skip date.SongAnnotation
getSongAnnotation()
AudioSongLocation
getSongLocation()
String
getSortAlbum()
Returns the "sort album".String
getSortAlbumArtist()
Returns the "sort album artist".String
getSortArtist()
Returns the "sort artist".String
getSortComposer()
Returns the sort composer.String
getSortName()
Returns the "sort name".String
getSortShow()
Returns the sort show.Float
getSpectralCentroidMean()
Average of the spectral centroids computed for individual windows of length ~23.22ms with a hopsize of half a window length.Float
getSpectralFluctuationPeak()
Peak of the averaged spectral fluctuation values computed for windows of length 23.22ms, with a hopsize of half a window.Float
getSpectralFluxMean()
Average of the spectral flux values computed for windows of length 23.22ms, with a hopsize of half a window.Float
getSpectralNoveltyMean()
Average of the spectral novelty values computed for windows of length 23.22ms, with a hopsize of half a window.Float
getSpectralSpreadMean()
Average of the spectral spread values computed for windows of length 23.22ms, with a hopsize of half a window.Float
getSpectralVariabilityMean()
Average of the spectral variability values computed for windows of length 23.22ms, with a hopsize of half a window.com.tagtraum.audiokern.timbre.BarkSpectrum
getSpectrum()
Returns the bark spectrum.float
getStart()
Start time of the song in seconds.int
getStartTime()
Start time of the song in ms.int
getStopTime()
Stop time of the song in ms.Set<String>
getTags()
Returns a set of tags associated with this song.com.tagtraum.audiokern.bpm.Tempo
getTempo()
Returns tempo.Color
getTempoColor()
Projection ofAudioSong.getTempoSpectrum()
to a color.com.tagtraum.audiokern.bpm.TempoSpectrum
getTempoSpectrum()
Returns the tempo spectrum.Color
getTempoTimbreColor()
Projection ofAudioSong.getTempoSpectrum()
andAudioSong.getSpectrum()
to a color.TimeSignature
getTimeSignature()
The song's time signature.String
getTimeSignatureAlgorithm()
Method the time signature was computed with.int
getTotalTime()
Total length of the song in ms.int
getTrackCount()
Number of tracks on album/release/recording.int
getTrackID()
Set<AudioId>
getTrackIds()
Returns track ids.int
getTrackNumber()
Get the number of the track on the release/album/recording.ReplayGain
getTrackReplayGain()
Replay gain for this track (not taking other tracks in an album into account).AudioSong.TrackType
getTrackType()
Track type.Integer
getTuning()
Tuning in cents.String
getTuningAlgorithm()
The method the current tuning was created with.int
getVideoHeight()
int
getVideoWidth()
int
getVolumeAdjustment()
Value between -255 and 255.String
getWork()
Classical work.int
getYear()
Release year - (corresponds to id3 TDRC, recording time).int
hashCode()
boolean
hasProtectedFileExtension()
Checks file endings instead of the protected flag in the iTunes Music Library.xml, since iTunes marks non-protected versions of files that used to be protected still as protected.void
init(AudioSong song)
boolean
isAlbumRatingComputed()
Indicates whether the value returned byAudioSong.getAlbumRating()
was computed or set manually.boolean
isClean()
Indicates whether this song is "clean" - whatever that means.boolean
isCompilation()
Indicates whether this track is part of a compilation.boolean
isDisabled()
Indicates whether this song is disabled or unchecked.boolean
isEnabled()
Indicates whether this song is enabled or checked.boolean
isExplicit()
Indicates whether this tracks is explicit or not.boolean
isHasVideo()
Indicates whether this track has a video.boolean
isHD()
Indicates whether this video content is in high definition (HD).boolean
isPartOfGaplessAlbum()
Indicates whether this songs is part of a gapless album.boolean
isProtected()
boolean
isPurchased()
Indicates whether this song was purchased (via the iTunes store).boolean
isRatingComputed()
Indicates whether the value returned byAudioSong.getRating()
was computed or set manually.boolean
isShared()
Indicates whether this track is a shared track, i.e.boolean
isUnplayed()
Indicates whether this songs has been played at some point.boolean
matches(Pattern[] patterns, PlayList.SubstringFilterProperty searchMode)
True if this object matches all provided patters (logical AND).void
removePropertyChangeListener(PropertyChangeListener listener)
Lets you remove a property change listener to this song.void
removePropertyChangeListener(String property, PropertyChangeListener listener)
Lets you remove a property change listener to this song.void
setAlbum(String album)
Sets album name.void
setAlbumArtist(String albumArtist)
Sets the album artist.void
setAlbumDisliked(boolean disliked)
void
setAlbumLiking(AudioSong.Liking value)
Set album liking.void
setAlbumLoved(boolean loved)
void
setAlbumRating(int value)
Sets album rating.void
setAlbumRatingComputed(boolean albumRatingComputed)
void
setAlbumReplayGain(ReplayGain replayGain)
Sets the replay gain for this album.void
setAlbumReplayGain(ReplayGain value, boolean updateITunNorm)
Sets the replay gain for this album.void
setAlertTone(boolean value)
void
setArtist(String artist)
Sets artist.void
setArtworkCount(int value)
void
setArtworks(AudioArtwork... artworks)
Set artworks belonging to this track.void
setAudiobook(boolean value)
void
setBackCoverArtwork(File... backCover)
Replace all back covers with the given files.void
setBeats(Beats value)
Sets this song's beats.void
setBeatsAlgorithm(String value)
Sets the algorithm the beats were computed with.void
setBeatsPerMinute(float value)
Sets beats per minute.void
setBeatsPerMinute(int value)
void
setBeatsPerMinuteAlgorithm(String value)
Sets the BPM algorithm.void
setBitRate(int value)
void
setBook(boolean value)
void
setClean(boolean value)
Sets the "clean" flag.void
setCloudStatus(AudioSong.CloudStatus cloudStatus)
void
setColor(Color value)
Sets the color.void
setComments(String comments)
Set comments.void
setCompilation(boolean value)
Marks this song as part of a compilation (or not).void
setComposer(String composer)
Sets composer.void
setContentRating(String value)
Sets the content rating.void
setCustom1(String value)
Custom field.void
setCustom2(String value)
Custom field.void
setCustom3(String value)
Custom field.void
setCustom4(String value)
Custom field.void
setCustom5(String value)
Custom field.void
setDanceability(Float value)
Danceability.void
setDanceabilityAlgorithm(String value)
Set the danceability algorithm.void
setDateAdded(Date value)
void
setDateAnalyzed(Date value)
Sets the date this song was last analyzed.void
setDateModified(Date value)
void
setDescription(String description)
Sets description/subtitle.void
setDisabled(boolean value)
Enables/disables this song.void
setDiscCount(int value)
Set disc count.void
setDiscNumber(int value)
Sets the disc number.void
setDisliked(boolean disliked)
void
setEnabled(boolean enabled)
Enables/disables this song.void
setEpisode(String episode)
Set episode name.void
setEpisodeOrder(int value)
Set episode order.void
setEqualizer(String equalizer)
void
setExplicit(boolean value)
Sets the "explicit" flag.void
setFileCreator(int value)
void
setFileFolderCount(int value)
void
setFileType(int value)
void
setFingerprint(byte[] fingerprint)
Sets the acoustic fingerprint.void
setFinish(float finish)
Sets the stop time in seconds.void
setFrontCoverArtwork(File... frontCover)
Replace all front covers with the given files.void
setGenre(String genre)
Sets genre.void
setGrouping(String grouping)
Sets the grouping.void
setHasVideo(boolean value)
Sets the "video" flag.void
setHD(boolean value)
Sets the HD flag.void
setHomeVideo(boolean value)
void
setId(Long value)
void
setId(String value)
void
setInstrumentation(AudioSong.Instrumentation instrumentation)
Sets the instrumentation property.void
setInstrumentationAlgorithm(String instrumentationAlgorithm)
Set the instrumentation algorithm.void
setITunesPropertiesHashCode(int value)
void
setiTunesU(boolean value)
void
setKey(Key value)
Sets the tonal key.void
setKeyAlgorithm(String value)
Set the key algorithm.void
setKind(String kind)
Allows you to store a String descriptor of the kind of audio object this is.void
setLanguage(String value)
Sets the language as ISO 639 three letter code.void
setLibraryFolderCount(int value)
void
setLiking(AudioSong.Liking value)
Set liking.void
setLocation(String location)
Sets the location.void
setLoudness(Loudness value)
Sets this song's loudness curve.void
setLoved(boolean loved)
void
setLyrics(String lyrics)
Sets lyrics.void
setMatched(boolean value)
void
setMediaKind(AudioSong.MediaKind value)
Set the kind of media, e.g.void
setMood(Mood value)
Sets this song's mood.void
setMoodAlgorithm(String value)
Sets the method the current mood value was created with.void
setMoodKeywords(Set<String> moodKeywords)
Persistent storage in database is not supported yet.void
setMovement(String movement)
Classical movement.void
setMovementCount(int value)
Classical movement count.void
setMovementNumber(int value)
Classical movement number.void
setMovie(boolean value)
void
setMusic(boolean value)
void
setMusicVideo(boolean value)
void
setName(String name)
Sets name.void
setPartOfGaplessAlbum(boolean value)
Sets the "gapless album" flag.void
setPlayCount(int value)
Set play count.void
setPlayDate(long value)
Set play date in milliseconds since January 1, 1970, 00:00:00 GMT (NOT related to the iTunes value!).void
setPlayDateUTC(Date value)
Set play time.void
setPlaylistId(Long value)
Typically not called by the user, but by the applicationvoid
setPodcast(boolean value)
void
setPopularity(float value)
Sets the value locally.void
setProtected(boolean value)
void
setPurchased(boolean value)
void
setRating(int value)
Sets the ratingvoid
setRatingComputed(boolean ratingComputed)
void
setRelativeSpectralEntropyMean(Float value)
Sets the average relative spectral entropy.void
setReleaseDate(Date value)
Set release date.void
setRemoteDisliked(float value)
Sets the value locally.void
setRemoteLoved(float value)
Sets the value locally.void
setRemotePlayFrequency(float value)
Sets the value locally.void
setRemotePlaySkipRatio(float value)
Sets the value locally.void
setRemoteRating(int value)
Sets the value locally.void
setRemoteUpdateDate(Date value)
Sets the date that marks the last update of remote properties.void
setRingTone(boolean value)
void
setRMSMean(Float value)
Sets the average RMS for the first 120 seconds of this song.void
setRMSStandardDeviation(Float value)
Sets the standard deviation of the root mean square (RMS).void
setSampleRate(int value)
void
setSeason(int value)
Set season.void
setSegments(Segments value)
Sets this song's segments.void
setSegmentsAlgorithm(String value)
Sets the algorithm the segments were computed with.void
setShow(String show)
Set show name.void
setSimilarities(Similarities value)
Sets this song's similarities.void
setSimilaritiesAlgorithm(String value)
Sets the algorithm the similarities were computed with.void
setSize(long value)
void
setSkipCount(int value)
Set skip count.void
setSkipDate(Date value)
Set skip date.void
setSongAnnotation(SongAnnotation songAnnotation)
void
setSortAlbum(String sortAlbum)
Sets the sort album.void
setSortAlbumArtist(String sortAlbumArtist)
Sets the sort album artist.void
setSortArtist(String sortArtist)
Sets the sort artist.void
setSortComposer(String sortComposer)
Sets the sort composer.void
setSortName(String sortName)
Sets the sort name.void
setSortShow(String sortShow)
Sets the sort show.void
setSpectralCentroidMean(Float value)
Sets the mean of the spectral centroids.void
setSpectralFluctuationPeak(Float value)
Peak of the spectral fluctuation values computed for windows of length 23.22ms, with a hopsize of half a window.void
setSpectralFluxMean(Float value)
Sets the mean spectral flux.void
setSpectralNoveltyMean(Float value)
Sets the average spectral novelty.void
setSpectralSpreadMean(Float value)
Sets the average spectral spread.void
setSpectralVariabilityMean(Float value)
Sets the mean spectral variability.void
setSpectrum(com.tagtraum.audiokern.timbre.BarkSpectrum value)
Sets the bark spectrum.void
setStart(float start)
Sets the start time in seconds.void
setStartTime(int value)
Set start time in ms.void
setStopTime(int value)
Sets stop time.void
setTags(Set<String> tags)
Sets a new set of tags.void
setTempo(com.tagtraum.audiokern.bpm.Tempo value)
Sets the tempo.void
setTempoColor(Color value)
Sets this song's tempo color.void
setTempoSpectrum(com.tagtraum.audiokern.bpm.TempoSpectrum value)
Sets the tempo spectrum.void
setTempoTimbreColor(Color value)
Sets this song's tempo-timbre color.void
setTimeSignature(TimeSignature value)
Sets this song's time signature.void
setTimeSignatureAlgorithm(String value)
Sets the algorithm the time signature was computed with.void
setTotalTime(int value)
void
setTrackCount(int trackCount)
Set track countvoid
setTrackID(int value)
void
setTrackNumber(int value)
Set the number of this track.void
setTrackReplayGain(ReplayGain replayGain)
Sets the replay gain for this track, not taking other tracks of the album into account.void
setTrackReplayGain(ReplayGain value, boolean updateITunNorm)
Sets the replay gain for this track, not taking other tracks of the album into account.void
setTrackType(AudioSong.TrackType value)
Field used by iTunes - typicallyAudioSong.TrackType.FILE
for files andAudioSong.TrackType.URL
for..void
setTrackType(String value)
void
setTuning(Integer value)
Sets tuning in cents (+-50).void
setTuningAlgorithm(String value)
Sets the tuning algorithm the current tuning value was computed with.void
setTvShow(boolean value)
void
setUnplayed(boolean value)
Sets unplayed.void
setVideoHeight(int value)
void
setVideoWidth(int value)
void
setVoiceMemo(boolean value)
void
setVolumeAdjustment(int value)
Sets the volume adjustmentvoid
setWork(String work)
Classical work.void
setYear(int value)
Sets the year.String
toString()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.tagtraum.audiokern.AudioSong
addBackCoverArtwork, addFrontCoverArtwork, getFile, getInstrumentationBasedOnGenreAndTags, getLocation, getPurchaseURL, getSyncTempoKey, getSyncTempoTuning, isAcousticBasedOnGenreTitleAndTags, isElectronicBasedOnGenreAndTags, refreshFromFile
-
-
-
-
Method Detail
-
init
public void init(AudioSong song)
-
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener propertyChangeListener)
Description copied from interface:AudioSong
Lets you add a property change listener to this song. This is an optional feature and may lead to exceptions.- Specified by:
addPropertyChangeListener
in interfaceAudioSong
- Parameters:
propertyChangeListener
- property change listener- See Also:
PropertyChangeSupport.addPropertyChangeListener(java.beans.PropertyChangeListener)
-
addPropertyChangeListener
public void addPropertyChangeListener(String property, PropertyChangeListener propertyChangeListener)
Description copied from interface:AudioSong
Lets you add a property change listener to this song. This is an optional feature and may lead to exceptions.- Specified by:
addPropertyChangeListener
in interfaceAudioSong
- Parameters:
property
- property namepropertyChangeListener
- property change listener- See Also:
PropertyChangeSupport.addPropertyChangeListener(java.beans.PropertyChangeListener)
-
removePropertyChangeListener
public void removePropertyChangeListener(String property, PropertyChangeListener listener)
Description copied from interface:AudioSong
Lets you remove a property change listener to this song. This is an optional feature and may lead to exceptions.- Specified by:
removePropertyChangeListener
in interfaceAudioSong
- Parameters:
property
- property namelistener
- property change listener- See Also:
PropertyChangeSupport.removePropertyChangeListener(PropertyChangeListener)
-
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
Description copied from interface:AudioSong
Lets you remove a property change listener to this song. This is an optional feature and may lead to exceptions.- Specified by:
removePropertyChangeListener
in interfaceAudioSong
- Parameters:
listener
- property change listener- See Also:
PropertyChangeSupport.removePropertyChangeListener(PropertyChangeListener)
-
getPropertyChangeListeners
public PropertyChangeListener[] getPropertyChangeListeners(String property)
- Specified by:
getPropertyChangeListeners
in interfaceAudioSong
- See Also:
PropertyChangeSupport.getPropertyChangeListeners(String)
-
getPropertyChangeListeners
public PropertyChangeListener[] getPropertyChangeListeners()
- Specified by:
getPropertyChangeListeners
in interfaceAudioSong
- See Also:
PropertyChangeSupport.getPropertyChangeListeners()
-
download
public void download()
Description copied from interface:AudioSong
Allows downloading of shared (e.g. podcasts) or iCloud tracks. May not be available on Windows.
You may be notified of a change in download status of a track by registering a
PropertyChangeListener
for one of the propertiesshared
,trackType
orlocation
.- Specified by:
download
in interfaceAudioSong
- See Also:
AudioSong.isShared()
,AudioSong.getTrackType()
,AudioSong.getCloudStatus()
-
isShared
public boolean isShared()
Description copied from interface:AudioSong
Indicates whether this track is a shared track, i.e. either from another iTunes library or an iTunes Match song that hasn't been downloaded yet.
-
getCloudStatus
public AudioSong.CloudStatus getCloudStatus()
Description copied from interface:AudioSong
Returns the cloud status, if available. Note that this call may be expensive, as it requires calling the iTunes API.- Specified by:
getCloudStatus
in interfaceAudioSong
- Returns:
- the status if available,
null
, if the feature is not supported (Windows, non-iTunes libraries, ...)
-
setCloudStatus
public void setCloudStatus(AudioSong.CloudStatus cloudStatus)
-
getPlayLists
public Collection<PlayList> getPlayLists()
Returns playlists the song belongs to.- Returns:
- playlists
-
getSongAnnotation
public SongAnnotation getSongAnnotation()
-
setSongAnnotation
public void setSongAnnotation(SongAnnotation songAnnotation)
-
createSongAnnotation
public SongAnnotation createSongAnnotation()
Creates and associates aSongAnnotation
with this Song, if no annotation exists yet.- Returns:
- a SongAnnotation associated with this Song
-
getImplementation
public <T> T getImplementation(Class<T> klass)
Description copied from interface:AudioSong
AudioSong
objects are sometimes implemented by an object that acts as a facade to other AudioSong objects. This could be a proxy for an AppleScript iTunes object, a a persistent object that is stored in a local database via Hibernate, or perhaps an Object that is capable of writing id3 tags directly (e.g.AudioMetaData
). While normal calls on an object implementing this interface are routed according to some internal logic, using one of the actual implementation classes allows you precise control over what your call does.Note to plugin developers: It is hardly ever a good idea to exercise this control, unless you know exactly what you are doing. :-)
- Specified by:
getImplementation
in interfaceAudioSong
- Type Parameters:
T
- implementation class- Parameters:
klass
- class implementing AudioSong- Returns:
- object of the desired type or
null
, if such an object is not available - See Also:
PlayList.getImplementation(Class)
-
getImplementations
public List<AudioSong> getImplementations()
Description copied from interface:AudioSong
Returns implementations of this interface instance.- Specified by:
getImplementations
in interfaceAudioSong
- Returns:
- implementations
- See Also:
AudioSong.getImplementation(Class)
-
getDescription
public String getDescription()
Description copied from interface:AudioSong
Description/subtitle of this song.- Specified by:
getDescription
in interfaceAudioSong
- Returns:
- description
-
setDescription
public void setDescription(String description)
Description copied from interface:AudioSong
Sets description/subtitle.- Specified by:
setDescription
in interfaceAudioSong
- Parameters:
description
- description
-
setWork
public void setWork(String work)
Description copied from interface:AudioSong
Classical work.
-
getMovement
public String getMovement()
Description copied from interface:AudioSong
Classical movement.- Specified by:
getMovement
in interfaceAudioSong
- Returns:
- movement
-
setMovement
public void setMovement(String movement)
Description copied from interface:AudioSong
Classical movement.- Specified by:
setMovement
in interfaceAudioSong
- Parameters:
movement
- movement
-
getMovementNumber
public int getMovementNumber()
Description copied from interface:AudioSong
Classical movement number.- Specified by:
getMovementNumber
in interfaceAudioSong
- Returns:
- movement number
-
setMovementNumber
public void setMovementNumber(int value)
Description copied from interface:AudioSong
Classical movement number.- Specified by:
setMovementNumber
in interfaceAudioSong
- Parameters:
value
- number
-
getMovementCount
public int getMovementCount()
Description copied from interface:AudioSong
Classical movement count.- Specified by:
getMovementCount
in interfaceAudioSong
- Returns:
- count
-
setMovementCount
public void setMovementCount(int value)
Description copied from interface:AudioSong
Classical movement count.- Specified by:
setMovementCount
in interfaceAudioSong
- Parameters:
value
- count
-
setArtist
public void setArtist(String artist)
Description copied from interface:AudioSong
Sets artist.
-
getAlbumArtist
public String getAlbumArtist()
Description copied from interface:AudioSong
Get album artist.- Specified by:
getAlbumArtist
in interfaceAudioSong
- Returns:
- album artist
-
setAlbumArtist
public void setAlbumArtist(String albumArtist)
Description copied from interface:AudioSong
Sets the album artist.- Specified by:
setAlbumArtist
in interfaceAudioSong
- Parameters:
albumArtist
- album artist
-
getComposer
public String getComposer()
Description copied from interface:AudioSong
Get composer(s).- Specified by:
getComposer
in interfaceAudioSong
- Returns:
- composer(s)
-
setComposer
public void setComposer(String composer)
Description copied from interface:AudioSong
Sets composer.- Specified by:
setComposer
in interfaceAudioSong
- Parameters:
composer
- composer
-
setAlbum
public void setAlbum(String album)
Description copied from interface:AudioSong
Sets album name.
-
getGrouping
public String getGrouping()
Description copied from interface:AudioSong
Get grouping.- Specified by:
getGrouping
in interfaceAudioSong
- Returns:
- grouping
-
setGrouping
public void setGrouping(String grouping)
Description copied from interface:AudioSong
Sets the grouping.- Specified by:
setGrouping
in interfaceAudioSong
- Parameters:
grouping
- grouping
-
setGenre
public void setGenre(String genre)
Description copied from interface:AudioSong
Sets genre.
-
getKind
public String getKind()
Description copied from interface:AudioSong
Kind of audio, e.g. "WAV audio file", "AAC audio file" or "MPEG audio file" (or localized versions thereof). This value is typically extracted fromiTunes Music Library.xml
and may simply benull
for non-iTunes libraries.
-
setKind
public void setKind(String kind)
Description copied from interface:AudioSong
Allows you to store a String descriptor of the kind of audio object this is. Typically this value is read-only (withAudioSong.getKind()
) and set by the music player, e.g. iTunes.- Specified by:
setKind
in interfaceAudioSong
- Parameters:
kind
- kind- See Also:
AudioSong.getKind()
-
getSize
public long getSize()
Description copied from interface:AudioSong
File size.
-
setSize
public void setSize(long value)
-
getTotalTime
public int getTotalTime()
Description copied from interface:AudioSong
Total length of the song in ms.- Specified by:
getTotalTime
in interfaceAudioSong
- Returns:
- length in ms.
-
setTotalTime
public void setTotalTime(int value)
-
getTrackID
public int getTrackID()
-
setTrackID
public void setTrackID(int value)
-
getTrackCount
public int getTrackCount()
Description copied from interface:AudioSong
Number of tracks on album/release/recording.- Specified by:
getTrackCount
in interfaceAudioSong
- Returns:
- track count
- See Also:
AudioSong.getTrackNumber()
-
getStartTime
public int getStartTime()
Description copied from interface:AudioSong
Start time of the song in ms.- Specified by:
getStartTime
in interfaceAudioSong
- Returns:
- start time in ms.
-
setStartTime
public void setStartTime(int value)
Description copied from interface:AudioSong
Set start time in ms.- Specified by:
setStartTime
in interfaceAudioSong
- Parameters:
value
- start time in ms
-
getStopTime
public int getStopTime()
Description copied from interface:AudioSong
Stop time of the song in ms.- Specified by:
getStopTime
in interfaceAudioSong
- Returns:
- stop time in ms.
-
setStopTime
public void setStopTime(int value)
Description copied from interface:AudioSong
Sets stop time.- Specified by:
setStopTime
in interfaceAudioSong
- Parameters:
value
- stop time in ms
-
getStart
public float getStart()
Description copied from interface:AudioSong
Start time of the song in seconds.- Specified by:
getStart
in interfaceAudioSong
- Returns:
- start time in seconds.
- See Also:
AudioSong.getStartTime()
-
setStart
public void setStart(float start)
Description copied from interface:AudioSong
Sets the start time in seconds.- Specified by:
setStart
in interfaceAudioSong
- Parameters:
start
- start time in seconds- See Also:
AudioSong.setStartTime(int)
-
getFinish
public float getFinish()
Description copied from interface:AudioSong
Stop time of the song in seconds.- Specified by:
getFinish
in interfaceAudioSong
- Returns:
- stop time in seconds.
- See Also:
AudioSong.getStopTime()
-
setFinish
public void setFinish(float finish)
Description copied from interface:AudioSong
Sets the stop time in seconds.- Specified by:
setFinish
in interfaceAudioSong
- Parameters:
finish
- stop time in seconds- See Also:
AudioSong.setStopTime(int)
-
setTrackCount
public void setTrackCount(int trackCount)
Description copied from interface:AudioSong
Set track count- Specified by:
setTrackCount
in interfaceAudioSong
- Parameters:
trackCount
- track count- See Also:
AudioSong.setTrackNumber(int)
-
getTrackNumber
public int getTrackNumber()
Description copied from interface:AudioSong
Get the number of the track on the release/album/recording.- Specified by:
getTrackNumber
in interfaceAudioSong
- Returns:
- track number
-
setTrackNumber
public void setTrackNumber(int value)
Description copied from interface:AudioSong
Set the number of this track.- Specified by:
setTrackNumber
in interfaceAudioSong
- Parameters:
value
- track number
-
getDiscNumber
public int getDiscNumber()
Description copied from interface:AudioSong
Get the disc number.- Specified by:
getDiscNumber
in interfaceAudioSong
- Returns:
- disc number
-
setDiscNumber
public void setDiscNumber(int value)
Description copied from interface:AudioSong
Sets the disc number.- Specified by:
setDiscNumber
in interfaceAudioSong
- Parameters:
value
- disc number
-
getDiscCount
public int getDiscCount()
Description copied from interface:AudioSong
Assuming that this song is on a disc that is part of a disc collection, return the number of discs in this collection.- Specified by:
getDiscCount
in interfaceAudioSong
- Returns:
- disc count
-
setDiscCount
public void setDiscCount(int value)
Description copied from interface:AudioSong
Set disc count.- Specified by:
setDiscCount
in interfaceAudioSong
- Parameters:
value
- disc count
-
getYear
public int getYear()
Description copied from interface:AudioSong
Release year - (corresponds to id3 TDRC, recording time).- Specified by:
getYear
in interfaceAudioSong
- Returns:
- four digit recording year, if available
- See Also:
AudioSong.getReleaseDate()
-
setYear
public void setYear(int value)
Description copied from interface:AudioSong
Sets the year.- Specified by:
setYear
in interfaceAudioSong
- Parameters:
value
- year- See Also:
AudioSong.getYear()
,AudioSong.getReleaseDate()
-
getReleaseYear
public int getReleaseYear()
-
getDateModified
public Date getDateModified()
Description copied from interface:AudioSong
Get date of last modification.- Specified by:
getDateModified
in interfaceAudioSong
- Returns:
- date
-
setDateModified
public void setDateModified(Date value)
-
getDateAdded
public Date getDateAdded()
Description copied from interface:AudioSong
Get date the song was added to the library.- Specified by:
getDateAdded
in interfaceAudioSong
- Returns:
- date added
-
setDateAdded
public void setDateAdded(Date value)
-
getBitRate
public int getBitRate()
Description copied from interface:AudioSong
Bit rate.- Specified by:
getBitRate
in interfaceAudioSong
- Returns:
- bit rate
-
setBitRate
public void setBitRate(int value)
-
getSampleRate
public int getSampleRate()
Description copied from interface:AudioSong
Get sample rate in Hz.- Specified by:
getSampleRate
in interfaceAudioSong
- Returns:
- sample rate in Hz
-
setSampleRate
public void setSampleRate(int value)
-
getEqualizer
public String getEqualizer()
-
setEqualizer
public void setEqualizer(String equalizer)
-
getTrackReplayGain
public ReplayGain getTrackReplayGain()
Description copied from interface:AudioSong
Replay gain for this track (not taking other tracks in an album into account).- Specified by:
getTrackReplayGain
in interfaceAudioSong
- Returns:
- replay gain
- See Also:
- "Radio" replay gain
-
setTrackReplayGain
public void setTrackReplayGain(ReplayGain value, boolean updateITunNorm)
Description copied from interface:AudioSong
Sets the replay gain for this track, not taking other tracks of the album into account.- Specified by:
setTrackReplayGain
in interfaceAudioSong
- Parameters:
value
- replay gainupdateITunNorm
- update the iTunNorm field with the given value- See Also:
AudioSong.getTrackReplayGain()
,AudioSong.getAlbumReplayGain()
-
setTrackReplayGain
public void setTrackReplayGain(ReplayGain replayGain)
Sets the replay gain for this track, not taking other tracks of the album into account. Calling this method will also update theiTunNORM
value, if possible.- Parameters:
replayGain
- replay gain- See Also:
setTrackReplayGain(ReplayGain, boolean)
-
getAlbumReplayGain
public ReplayGain getAlbumReplayGain()
Description copied from interface:AudioSong
Replay gain for this album.- Specified by:
getAlbumReplayGain
in interfaceAudioSong
- Returns:
- replay gain
- See Also:
- "Audiophile" replay gain,
AudioSong.getTrackReplayGain()
-
setAlbumReplayGain
public void setAlbumReplayGain(ReplayGain value, boolean updateITunNorm)
Description copied from interface:AudioSong
Sets the replay gain for this album.- Specified by:
setAlbumReplayGain
in interfaceAudioSong
- Parameters:
value
- replay gainupdateITunNorm
- update the iTunNorm field with the given value- See Also:
AudioSong.getAlbumReplayGain()
-
setAlbumReplayGain
public void setAlbumReplayGain(ReplayGain replayGain)
Sets the replay gain for this album. Calling this method will not update theiTunNORM
value.- Parameters:
replayGain
- replay gain- See Also:
setAlbumReplayGain(ReplayGain, boolean)
-
getVolumeAdjustment
public int getVolumeAdjustment()
Description copied from interface:AudioSong
Value between -255 and 255.- Specified by:
getVolumeAdjustment
in interfaceAudioSong
- Returns:
- volume adjustment
-
setVolumeAdjustment
public void setVolumeAdjustment(int value)
Description copied from interface:AudioSong
Sets the volume adjustment- Specified by:
setVolumeAdjustment
in interfaceAudioSong
- Parameters:
value
- value between -255 and 255.
-
getComments
public String getComments()
Description copied from interface:AudioSong
Get comments.- Specified by:
getComments
in interfaceAudioSong
- Returns:
- comments
-
setComments
public void setComments(String comments)
Description copied from interface:AudioSong
Set comments.- Specified by:
setComments
in interfaceAudioSong
- Parameters:
comments
- comments
-
getPlayCount
public int getPlayCount()
Description copied from interface:AudioSong
Get the number of times the song was played.- Specified by:
getPlayCount
in interfaceAudioSong
- Returns:
- play count
-
setPlayCount
public void setPlayCount(int value)
Description copied from interface:AudioSong
Set play count.- Specified by:
setPlayCount
in interfaceAudioSong
- Parameters:
value
- play count
-
getPlayDate
public long getPlayDate()
Description copied from interface:AudioSong
Get time the song was last played. Returns0
, if it has never been played.- Specified by:
getPlayDate
in interfaceAudioSong
- Returns:
- play date, milliseconds since January 1, 1970, 00:00:00 GMT (NOT related to the iTunes value!)
-
setPlayDate
public void setPlayDate(long value)
Description copied from interface:AudioSong
Set play date in milliseconds since January 1, 1970, 00:00:00 GMT (NOT related to the iTunes value!).- Specified by:
setPlayDate
in interfaceAudioSong
- Parameters:
value
- play date
-
getPlayDateUTC
public Date getPlayDateUTC()
Description copied from interface:AudioSong
Get play date.- Specified by:
getPlayDateUTC
in interfaceAudioSong
- Returns:
- play date
-
setPlayDateUTC
public void setPlayDateUTC(Date value)
Description copied from interface:AudioSong
Set play time.- Specified by:
setPlayDateUTC
in interfaceAudioSong
- Parameters:
value
- play time
-
getSkipCount
public int getSkipCount()
Description copied from interface:AudioSong
Get skip count.- Specified by:
getSkipCount
in interfaceAudioSong
- Returns:
- skip count
-
setSkipCount
public void setSkipCount(int value)
Description copied from interface:AudioSong
Set skip count.- Specified by:
setSkipCount
in interfaceAudioSong
- Parameters:
value
- skip count
-
getSkipDate
public Date getSkipDate()
Description copied from interface:AudioSong
Get skip date.- Specified by:
getSkipDate
in interfaceAudioSong
- Returns:
- skip date
-
setSkipDate
public void setSkipDate(Date value)
Description copied from interface:AudioSong
Set skip date.- Specified by:
setSkipDate
in interfaceAudioSong
- Parameters:
value
- skip date
-
getReleaseDate
public Date getReleaseDate()
Description copied from interface:AudioSong
Release year (corresponds to id3 TDRL).- Specified by:
getReleaseDate
in interfaceAudioSong
- Returns:
- release time
-
setReleaseDate
public void setReleaseDate(Date value)
Description copied from interface:AudioSong
Set release date.- Specified by:
setReleaseDate
in interfaceAudioSong
- Parameters:
value
- release date
-
getArtworkCount
public int getArtworkCount()
Description copied from interface:AudioSong
Get artwork count.- Specified by:
getArtworkCount
in interfaceAudioSong
- Returns:
- artwork count
-
getImage
public Image getImage()
Description copied from interface:AudioSong
First artwork image.- Specified by:
getImage
in interfaceAudioSong
- Returns:
- first artwork image of this track.
- See Also:
AudioSong.getFrontCoverImage()
,AudioSong.getBackCoverImage()
-
setArtworkCount
public void setArtworkCount(int value)
-
getRating
public int getRating()
Description copied from interface:AudioSong
Value ranging from 0-100, 100 being best.- Specified by:
getRating
in interfaceAudioSong
- Returns:
- rating
- See Also:
AudioSong.isRatingComputed()
,AudioSong.getAlbumRating()
-
setRating
public void setRating(int value)
Description copied from interface:AudioSong
Sets the rating- Specified by:
setRating
in interfaceAudioSong
- Parameters:
value
- rating between from 0 to 100- See Also:
AudioSong.getRating()
-
getAlbumRating
public int getAlbumRating()
Description copied from interface:AudioSong
Get album rating.- Specified by:
getAlbumRating
in interfaceAudioSong
- Returns:
- album rating
- See Also:
AudioSong.isAlbumRatingComputed()
-
setAlbumRating
public void setAlbumRating(int value)
Description copied from interface:AudioSong
Sets album rating.- Specified by:
setAlbumRating
in interfaceAudioSong
- Parameters:
value
- album rating
-
isRatingComputed
public boolean isRatingComputed()
Description copied from interface:AudioSong
Indicates whether the value returned byAudioSong.getRating()
was computed or set manually.- Specified by:
isRatingComputed
in interfaceAudioSong
- Returns:
true
orfalse
-
setRatingComputed
public void setRatingComputed(boolean ratingComputed)
-
isAlbumRatingComputed
public boolean isAlbumRatingComputed()
Description copied from interface:AudioSong
Indicates whether the value returned byAudioSong.getAlbumRating()
was computed or set manually.- Specified by:
isAlbumRatingComputed
in interfaceAudioSong
- Returns:
true
orfalse
-
setAlbumRatingComputed
public void setAlbumRatingComputed(boolean albumRatingComputed)
-
setRemoteUpdateDate
public void setRemoteUpdateDate(Date value)
Description copied from interface:AudioSong
Sets the date that marks the last update of remote properties. This method is usually called by the app, not the user or any user/plugin code.- Specified by:
setRemoteUpdateDate
in interfaceAudioSong
- Parameters:
value
- date- See Also:
AudioSong.getRemoteUpdateDate()
-
getRemoteUpdateDate
public Date getRemoteUpdateDate()
Description copied from interface:AudioSong
Time the remote properties of this song were last updated. Remote are e.g.AudioSong.getRemotePlayFrequency()
orAudioSong.getPopularity()
.- Specified by:
getRemoteUpdateDate
in interfaceAudioSong
- Returns:
- date or
null
, if never
-
getRemoteRating
public int getRemoteRating()
Description copied from interface:AudioSong
Average of other people's ratings.- Specified by:
getRemoteRating
in interfaceAudioSong
- Returns:
- mean of ratings
-
setRemoteRating
public void setRemoteRating(int value)
Description copied from interface:AudioSong
Sets the value locally. In other words, the value is not propagated to the central database.- Specified by:
setRemoteRating
in interfaceAudioSong
- Parameters:
value
- value
-
getPopularity
public float getPopularity()
Description copied from interface:AudioSong
Popularity as a value between 0 and 1.- Specified by:
getPopularity
in interfaceAudioSong
- Returns:
- popularity among all users
-
setPopularity
public void setPopularity(float value)
Description copied from interface:AudioSong
Sets the value locally. In other words, the value is not propagated to the central database.- Specified by:
setPopularity
in interfaceAudioSong
- Parameters:
value
- value
-
getRemotePlayFrequency
public float getRemotePlayFrequency()
Description copied from interface:AudioSong
Average of play frequencies as reported by users.- Specified by:
getRemotePlayFrequency
in interfaceAudioSong
- Returns:
- play frequency
- See Also:
AudioSong.getPlayFrequency()
-
setRemotePlayFrequency
public void setRemotePlayFrequency(float value)
Description copied from interface:AudioSong
Sets the value locally. In other words, the value is not propagated to the central database.- Specified by:
setRemotePlayFrequency
in interfaceAudioSong
- Parameters:
value
- value
-
getRemotePlaySkipRatio
public float getRemotePlaySkipRatio()
Description copied from interface:AudioSong
Play/skip ratio by all users with this song.- Specified by:
getRemotePlaySkipRatio
in interfaceAudioSong
- Returns:
- play/skip ratio
- See Also:
AudioSong.getPlaySkipRatio()
-
setRemotePlaySkipRatio
public void setRemotePlaySkipRatio(float value)
Description copied from interface:AudioSong
Sets the value locally. In other words, the value is not propagated to the central database.- Specified by:
setRemotePlaySkipRatio
in interfaceAudioSong
- Parameters:
value
- value
-
getRemoteLoved
public float getRemoteLoved()
Description copied from interface:AudioSong
Indicates, what percentage of people "love" this song. May be much lower than expected.- Specified by:
getRemoteLoved
in interfaceAudioSong
- Returns:
- value between 0 and 1.
- See Also:
AudioSong.getRemoteDisliked()
,AudioSong.getLiking()
-
setRemoteLoved
public void setRemoteLoved(float value)
Description copied from interface:AudioSong
Sets the value locally. In other words, the value is not propagated to the central database.- Specified by:
setRemoteLoved
in interfaceAudioSong
- Parameters:
value
- value
-
getRemoteDisliked
public float getRemoteDisliked()
Description copied from interface:AudioSong
Indicates, what percentage of people "dislike" this song. May be much lower than expected.- Specified by:
getRemoteDisliked
in interfaceAudioSong
- Returns:
- value between 0 and 1.
- See Also:
AudioSong.getRemoteLoved()
,AudioSong.getLiking()
-
setRemoteDisliked
public void setRemoteDisliked(float value)
Description copied from interface:AudioSong
Sets the value locally. In other words, the value is not propagated to the central database.- Specified by:
setRemoteDisliked
in interfaceAudioSong
- Parameters:
value
- value
-
setLoved
public void setLoved(boolean loved)
-
setDisliked
public void setDisliked(boolean disliked)
-
setAlbumLoved
public void setAlbumLoved(boolean loved)
-
setAlbumDisliked
public void setAlbumDisliked(boolean disliked)
-
getLiking
public AudioSong.Liking getLiking()
Description copied from interface:AudioSong
Liking. This is an expression of iTunes' loved and disliked fields.
-
setLiking
public void setLiking(AudioSong.Liking value)
Description copied from interface:AudioSong
Set liking.
-
getAlbumLiking
public AudioSong.Liking getAlbumLiking()
Description copied from interface:AudioSong
Is album liked. This is an expression of iTunes' album loved and album disliked fields.- Specified by:
getAlbumLiking
in interfaceAudioSong
- Returns:
- liking
-
setAlbumLiking
public void setAlbumLiking(AudioSong.Liking value)
Description copied from interface:AudioSong
Set album liking.- Specified by:
setAlbumLiking
in interfaceAudioSong
- Parameters:
value
- liking
-
setInstrumentation
public void setInstrumentation(AudioSong.Instrumentation instrumentation)
Description copied from interface:AudioSong
Sets the instrumentation property.- Specified by:
setInstrumentation
in interfaceAudioSong
- Parameters:
instrumentation
- instrumentation
-
getInstrumentation
public AudioSong.Instrumentation getInstrumentation()
Description copied from interface:AudioSong
Indicates whether this song qualifies as "electronic" or "acoustic".- Specified by:
getInstrumentation
in interfaceAudioSong
- Returns:
- instrumentation
-
setInstrumentationAlgorithm
public void setInstrumentationAlgorithm(String instrumentationAlgorithm)
Description copied from interface:AudioSong
Set the instrumentation algorithm. Should beEntered
, if the value was entered manually.- Specified by:
setInstrumentationAlgorithm
in interfaceAudioSong
- Parameters:
instrumentationAlgorithm
- instrumentation algorithm
-
getInstrumentationAlgorithm
public String getInstrumentationAlgorithm()
Description copied from interface:AudioSong
Returns the name of the instrumentation algorithm. May beEntered
, if the value was entered.- Specified by:
getInstrumentationAlgorithm
in interfaceAudioSong
- Returns:
- instrumentation algorithm
-
setDanceability
public void setDanceability(Float value)
Description copied from interface:AudioSong
Danceability.- Specified by:
setDanceability
in interfaceAudioSong
- Parameters:
value
- normalized positive value (0-1)
-
getDanceability
public Float getDanceability()
Description copied from interface:AudioSong
Danceability.- Specified by:
getDanceability
in interfaceAudioSong
- Returns:
- normalized positive value (0-1)
-
setDanceabilityAlgorithm
public void setDanceabilityAlgorithm(String value)
Description copied from interface:AudioSong
Set the danceability algorithm. Should beEntered
, if the value was entered manually.- Specified by:
setDanceabilityAlgorithm
in interfaceAudioSong
- Parameters:
value
- danceability algorithm
-
getDanceabilityAlgorithm
public String getDanceabilityAlgorithm()
Description copied from interface:AudioSong
Returns the name of the danceability algorithm. May beEntered
, if the value was entered.- Specified by:
getDanceabilityAlgorithm
in interfaceAudioSong
- Returns:
- danceability algorithm
-
getShow
public String getShow()
Description copied from interface:AudioSong
Name of a show, suitable for TV shows.
-
setShow
public void setShow(String show)
Description copied from interface:AudioSong
Set show name.
-
getSeason
public int getSeason()
Description copied from interface:AudioSong
Get season number. Suitable for TV-shows.
-
setSeason
public void setSeason(int value)
Description copied from interface:AudioSong
Set season.
-
getEpisode
public String getEpisode()
Description copied from interface:AudioSong
Get episode name.- Specified by:
getEpisode
in interfaceAudioSong
- Returns:
- episode name
-
setEpisode
public void setEpisode(String episode)
Description copied from interface:AudioSong
Set episode name.- Specified by:
setEpisode
in interfaceAudioSong
- Parameters:
episode
- episode name
-
getEpisodeOrder
public int getEpisodeOrder()
Description copied from interface:AudioSong
Episode order.- Specified by:
getEpisodeOrder
in interfaceAudioSong
- Returns:
- episode order
-
setEpisodeOrder
public void setEpisodeOrder(int value)
Description copied from interface:AudioSong
Set episode order.- Specified by:
setEpisodeOrder
in interfaceAudioSong
- Parameters:
value
- episode order
-
isCompilation
public boolean isCompilation()
Description copied from interface:AudioSong
Indicates whether this track is part of a compilation.
"A compilation album is an album (music or spoken-word) featuring tracks from one or more performers, often culled from a variety of sources (such as studio albums, live albums, singles, demos and outtakes.)"
-- Wikipedia Album Compliation- Specified by:
isCompilation
in interfaceAudioSong
- Returns:
true
orfalse
-
setCompilation
public void setCompilation(boolean value)
Description copied from interface:AudioSong
Marks this song as part of a compilation (or not).- Specified by:
setCompilation
in interfaceAudioSong
- Parameters:
value
-true
orfalse
-
getId
public Long getId()
Description copied from interface:AudioSong
Persistent id. Survives application shutdown.
-
setId
public void setId(String value)
-
setId
public void setId(Long value)
-
isDisabled
public boolean isDisabled()
Description copied from interface:AudioSong
Indicates whether this song is disabled or unchecked.- Specified by:
isDisabled
in interfaceAudioSong
- Returns:
- !
AudioSong.isEnabled()
-
setDisabled
public void setDisabled(boolean value)
Description copied from interface:AudioSong
Enables/disables this song.- Specified by:
setDisabled
in interfaceAudioSong
- Parameters:
value
-true
orfalse
-
isEnabled
public boolean isEnabled()
Description copied from interface:AudioSong
Indicates whether this song is enabled or checked.
-
setEnabled
public void setEnabled(boolean enabled)
Description copied from interface:AudioSong
Enables/disables this song.- Specified by:
setEnabled
in interfaceAudioSong
- Parameters:
enabled
-true
orfalse
-
getTrackType
public AudioSong.TrackType getTrackType()
Description copied from interface:AudioSong
Track type. E.g.AudioSong.TrackType.FILE
.- Specified by:
getTrackType
in interfaceAudioSong
- Returns:
- track type
- See Also:
AudioSong.setTrackType(TrackType)
-
setTrackType
public void setTrackType(AudioSong.TrackType value)
Description copied from interface:AudioSong
Field used by iTunes - typicallyAudioSong.TrackType.FILE
for files andAudioSong.TrackType.URL
for.. well, guess what?! Typically you don't set this field manually.- Specified by:
setTrackType
in interfaceAudioSong
- Parameters:
value
- track type- See Also:
AudioSong.getTrackType()
-
getFileType
public int getFileType()
-
setFileType
public void setFileType(int value)
-
getFileCreator
public int getFileCreator()
-
setFileCreator
public void setFileCreator(int value)
-
setMediaKind
public void setMediaKind(AudioSong.MediaKind value)
Description copied from interface:AudioSong
Set the kind of media, e.g.AudioSong.MediaKind.AUDIOBOOK
.- Specified by:
setMediaKind
in interfaceAudioSong
- Parameters:
value
- media kind
-
getMediaKind
public AudioSong.MediaKind getMediaKind()
Description copied from interface:AudioSong
Media kind of this object.- Specified by:
getMediaKind
in interfaceAudioSong
- Returns:
- kind of media
-
setMatched
public void setMatched(boolean value)
-
setPodcast
public void setPodcast(boolean value)
-
setAudiobook
public void setAudiobook(boolean value)
-
setiTunesU
public void setiTunesU(boolean value)
-
setTvShow
public void setTvShow(boolean value)
-
setMusicVideo
public void setMusicVideo(boolean value)
-
setMovie
public void setMovie(boolean value)
-
setHomeVideo
public void setHomeVideo(boolean value)
-
setBook
public void setBook(boolean value)
-
setAlertTone
public void setAlertTone(boolean value)
-
setRingTone
public void setRingTone(boolean value)
-
setVoiceMemo
public void setVoiceMemo(boolean value)
-
setMusic
public void setMusic(boolean value)
-
setTrackType
public void setTrackType(String value)
-
isUnplayed
public boolean isUnplayed()
Description copied from interface:AudioSong
Indicates whether this songs has been played at some point.- Specified by:
isUnplayed
in interfaceAudioSong
- Returns:
true
orfalse
-
setUnplayed
public void setUnplayed(boolean value)
Description copied from interface:AudioSong
Sets unplayed.- Specified by:
setUnplayed
in interfaceAudioSong
- Parameters:
value
- unplayed
-
isHasVideo
public boolean isHasVideo()
Description copied from interface:AudioSong
Indicates whether this track has a video.- Specified by:
isHasVideo
in interfaceAudioSong
- Returns:
true
orfalse
-
setHasVideo
public void setHasVideo(boolean value)
Description copied from interface:AudioSong
Sets the "video" flag.- Specified by:
setHasVideo
in interfaceAudioSong
- Parameters:
value
-true
orfalse
-
isProtected
public boolean isProtected()
Description copied from interface:AudioSong
- Specified by:
isProtected
in interfaceAudioSong
- Returns:
true
orfalse
-
setProtected
public void setProtected(boolean value)
-
getLocation
public String getLocation(boolean refresh)
Description copied from interface:AudioSong
Location of this track. Ifrefresh
is true and no location is available or the resource does not exist anymore, ask the backend app (iTunes, Music.app, ...) for the correct path. Because of the backend call, this method may block and therefore should be called from the EDT.- Specified by:
getLocation
in interfaceAudioSong
- Parameters:
refresh
- refresh from backend- Returns:
- location
- See Also:
AudioSong.getLocation()
,AudioSong.getFile(boolean)
-
setLocation
public void setLocation(String location)
Description copied from interface:AudioSong
Sets the location.- Specified by:
setLocation
in interfaceAudioSong
- Parameters:
location
- location
-
getSongLocation
public AudioSongLocation getSongLocation()
-
getFileFolderCount
public int getFileFolderCount()
-
setFileFolderCount
public void setFileFolderCount(int value)
-
getLibraryFolderCount
public int getLibraryFolderCount()
-
setLibraryFolderCount
public void setLibraryFolderCount(int value)
-
isPartOfGaplessAlbum
public boolean isPartOfGaplessAlbum()
Description copied from interface:AudioSong
Indicates whether this songs is part of a gapless album.- Specified by:
isPartOfGaplessAlbum
in interfaceAudioSong
- Returns:
true
orfalse
-
setPartOfGaplessAlbum
public void setPartOfGaplessAlbum(boolean value)
Description copied from interface:AudioSong
Sets the "gapless album" flag.- Specified by:
setPartOfGaplessAlbum
in interfaceAudioSong
- Parameters:
value
-true
orfalse
-
isClean
public boolean isClean()
Description copied from interface:AudioSong
Indicates whether this song is "clean" - whatever that means. "Clean" and "explicit" are mutually exclusive.- Specified by:
isClean
in interfaceAudioSong
- Returns:
true
orfalse
- See Also:
AudioSong.isExplicit()
-
setClean
public void setClean(boolean value)
Description copied from interface:AudioSong
Sets the "clean" flag. "Clean" and "explicit" are mutually exclusive.- Specified by:
setClean
in interfaceAudioSong
- Parameters:
value
-true
orfalse
- See Also:
AudioSong.setExplicit(boolean)
-
isExplicit
public boolean isExplicit()
Description copied from interface:AudioSong
Indicates whether this tracks is explicit or not. "Clean" and "explicit" are mutually exclusive.- Specified by:
isExplicit
in interfaceAudioSong
- Returns:
true
orfalse
- See Also:
AudioSong.isClean()
-
setExplicit
public void setExplicit(boolean value)
Description copied from interface:AudioSong
Sets the "explicit" flag. "Clean" and "explicit" are mutually exclusive.- Specified by:
setExplicit
in interfaceAudioSong
- Parameters:
value
-true
orfalse
- See Also:
AudioSong.setClean(boolean)
-
isHD
public boolean isHD()
Description copied from interface:AudioSong
Indicates whether this video content is in high definition (HD).
-
setHD
public void setHD(boolean value)
Description copied from interface:AudioSong
Sets the HD flag.
-
getSortArtist
public String getSortArtist()
Description copied from interface:AudioSong
Returns the "sort artist". E.g., for "The Beatles" the sort artist is "Beatles".- Specified by:
getSortArtist
in interfaceAudioSong
- Returns:
- sort artist
-
setSortArtist
public void setSortArtist(String sortArtist)
Description copied from interface:AudioSong
Sets the sort artist.- Specified by:
setSortArtist
in interfaceAudioSong
- Parameters:
sortArtist
- sort artist
-
getSortAlbum
public String getSortAlbum()
Description copied from interface:AudioSong
Returns the "sort album". E.g., for "A Hard Day's Night" the sort album is "Hard Day's Night".- Specified by:
getSortAlbum
in interfaceAudioSong
- Returns:
- sort album
-
setSortAlbum
public void setSortAlbum(String sortAlbum)
Description copied from interface:AudioSong
Sets the sort album.- Specified by:
setSortAlbum
in interfaceAudioSong
- Parameters:
sortAlbum
- sort album
-
getSortName
public String getSortName()
Description copied from interface:AudioSong
Returns the "sort name". E.g., for "A Taste of Honey" the sort name is "Taste of Honey".- Specified by:
getSortName
in interfaceAudioSong
- Returns:
- sort name
-
setSortName
public void setSortName(String sortName)
Description copied from interface:AudioSong
Sets the sort name.- Specified by:
setSortName
in interfaceAudioSong
- Parameters:
sortName
- sort name
-
getSortAlbumArtist
public String getSortAlbumArtist()
Description copied from interface:AudioSong
Returns the "sort album artist". E.g., for "The Beatles" the sort album artist is "Beatles".- Specified by:
getSortAlbumArtist
in interfaceAudioSong
- Returns:
- sort album artist
-
setSortAlbumArtist
public void setSortAlbumArtist(String sortAlbumArtist)
Description copied from interface:AudioSong
Sets the sort album artist.- Specified by:
setSortAlbumArtist
in interfaceAudioSong
- Parameters:
sortAlbumArtist
- sort album artist
-
getSortComposer
public String getSortComposer()
Description copied from interface:AudioSong
Returns the sort composer.- Specified by:
getSortComposer
in interfaceAudioSong
- Returns:
- sort composer
-
setSortComposer
public void setSortComposer(String sortComposer)
Description copied from interface:AudioSong
Sets the sort composer.- Specified by:
setSortComposer
in interfaceAudioSong
- Parameters:
sortComposer
- sort composer
-
getSortShow
public String getSortShow()
Description copied from interface:AudioSong
Returns the sort show.- Specified by:
getSortShow
in interfaceAudioSong
- Returns:
- sort show
-
setSortShow
public void setSortShow(String sortShow)
Description copied from interface:AudioSong
Sets the sort show.- Specified by:
setSortShow
in interfaceAudioSong
- Parameters:
sortShow
- sort show
-
getContentRating
public String getContentRating()
Description copied from interface:AudioSong
Returns the content rating. E.g., "us-tv|TV-PG|400|" or "us-tv|TV-MA|600|dialogue and sexual content"- Specified by:
getContentRating
in interfaceAudioSong
- Returns:
- content rating
-
setContentRating
public void setContentRating(String value)
Description copied from interface:AudioSong
Sets the content rating.- Specified by:
setContentRating
in interfaceAudioSong
- Parameters:
value
- content rating
-
isPurchased
public boolean isPurchased()
Description copied from interface:AudioSong
Indicates whether this song was purchased (via the iTunes store).- Specified by:
isPurchased
in interfaceAudioSong
- Returns:
true
orfalse
-
setPurchased
public void setPurchased(boolean value)
-
getVideoHeight
public int getVideoHeight()
-
setVideoHeight
public void setVideoHeight(int value)
-
getVideoWidth
public int getVideoWidth()
-
setVideoWidth
public void setVideoWidth(int value)
-
getPlayFrequency
public double getPlayFrequency()
Played per 100 days.- Specified by:
getPlayFrequency
in interfaceAudioSong
- Returns:
- played per 100 days
- See Also:
AudioSong.getRemotePlayFrequency()
-
getPlaySkipRatio
public double getPlaySkipRatio()
Description copied from interface:AudioSong
Play/Skip ratio. Defined asplayCount/(skipCount+1)
.- Specified by:
getPlaySkipRatio
in interfaceAudioSong
- Returns:
- playSkip ratio as defined above
- See Also:
AudioSong.getRemotePlaySkipRatio()
,AudioSong.getPopularity()
-
getFile
public Path getFile(boolean refresh)
Description copied from interface:AudioSong
File of this track. Ifrefresh
is true and the file does not exist anymore, ask the backend app (iTunes, Music.app, ...) for the correct file name. Because of the backend call, this method may block and therefore should be called from the EDT.- Specified by:
getFile
in interfaceAudioSong
- Parameters:
refresh
- refresh from backend- Returns:
- file object for
AudioSong.getLocation()
or null, if a proper file object cannot be formed - See Also:
AudioSong.getLocation()
,AudioSong.getLocation(boolean)
-
getPath
public String getPath()
Description copied from interface:AudioSong
Path.- Specified by:
getPath
in interfaceAudioSong
- Returns:
- path object for
AudioSong.getLocation()
or null, if a proper file object cannot be formed
-
getITunesPropertiesHashCode
public int getITunesPropertiesHashCode()
Hash code for the iTunes parts of this song.- Returns:
- hash code, if set
- See Also:
ITunesPropertiesHashCode.hashCode(java.util.Map)
-
setITunesPropertiesHashCode
public void setITunesPropertiesHashCode(int value)
-
canWrite
public boolean canWrite()
Checks whether the file corresponding to this song can in principal be written to.
-
hasProtectedFileExtension
public boolean hasProtectedFileExtension()
Checks file endings instead of the protected flag in the iTunes Music Library.xml, since iTunes marks non-protected versions of files that used to be protected still as protected.- Specified by:
hasProtectedFileExtension
in interfaceAudioSong
- Returns:
- true, if we know that the file format is usually protected.
-
getAudioMetaData
public AudioMetaData getAudioMetaData()
Gets some audio meta data for this song from the actual file. The result is cached with a soft reference.- Returns:
- audio meta data for this song
-
getAudioMetaData
public AudioMetaData getAudioMetaData(boolean fresh)
Gets some audio meta data for this song from the actual file. The result is cached with a soft reference.- Parameters:
fresh
- if true the AudioMetaData is freshly read from file- Returns:
- audio meta data for this song
-
matches
public boolean matches(Pattern[] patterns, PlayList.SubstringFilterProperty searchMode)
Description copied from interface:Matchable
True if this object matches all provided patters (logical AND).- Specified by:
matches
in interfaceMatchable<PlayList.SubstringFilterProperty>
- Parameters:
patterns
- patternssearchMode
- specifies a particular way in which the match should occur- Returns:
- true if this object matches.
-
getCustom1
public String getCustom1()
Description copied from interface:AudioSong
Custom field.- Specified by:
getCustom1
in interfaceAudioSong
- Returns:
- custom field
-
setCustom1
public void setCustom1(String value)
Description copied from interface:AudioSong
Custom field.- Specified by:
setCustom1
in interfaceAudioSong
- Parameters:
value
- custom field value
-
getCustom2
public String getCustom2()
Description copied from interface:AudioSong
Custom field.- Specified by:
getCustom2
in interfaceAudioSong
- Returns:
- custom field
-
setCustom2
public void setCustom2(String value)
Description copied from interface:AudioSong
Custom field.- Specified by:
setCustom2
in interfaceAudioSong
- Parameters:
value
- custom field value
-
getCustom3
public String getCustom3()
Description copied from interface:AudioSong
Custom field.- Specified by:
getCustom3
in interfaceAudioSong
- Returns:
- custom field
-
setCustom3
public void setCustom3(String value)
Description copied from interface:AudioSong
Custom field.- Specified by:
setCustom3
in interfaceAudioSong
- Parameters:
value
- custom field value
-
getCustom4
public String getCustom4()
Description copied from interface:AudioSong
Custom field.- Specified by:
getCustom4
in interfaceAudioSong
- Returns:
- custom field
-
setCustom4
public void setCustom4(String value)
Description copied from interface:AudioSong
Custom field.- Specified by:
setCustom4
in interfaceAudioSong
- Parameters:
value
- custom field value
-
getCustom5
public String getCustom5()
Description copied from interface:AudioSong
Custom field.- Specified by:
getCustom5
in interfaceAudioSong
- Returns:
- custom field
-
setCustom5
public void setCustom5(String value)
Description copied from interface:AudioSong
Custom field.- Specified by:
setCustom5
in interfaceAudioSong
- Parameters:
value
- custom field value
-
getTags
public Set<String> getTags()
Description copied from interface:AudioSong
Returns a set of tags associated with this song. To manipulate this song's tag, please useAudioSong.setTags(java.util.Set)
and don't manipulate the returned set.
-
setTags
public void setTags(Set<String> tags)
Description copied from interface:AudioSong
Sets a new set of tags.
-
getDateAnalyzed
public Date getDateAnalyzed()
Description copied from interface:AudioSong
Date the song was last analyzed.- Specified by:
getDateAnalyzed
in interfaceAudioSong
- Returns:
- date analyzed
-
setDateAnalyzed
public void setDateAnalyzed(Date value)
Description copied from interface:AudioSong
Sets the date this song was last analyzed.- Specified by:
setDateAnalyzed
in interfaceAudioSong
- Parameters:
value
- date of last analysis
-
getKey
public Key getKey()
Description copied from interface:AudioSong
Return the tonal key of this song. E.g.,MajorKey.C_MAJOR
.
-
setKey
public void setKey(Key value)
Description copied from interface:AudioSong
Sets the tonal key.- Specified by:
setKey
in interfaceAudioSong
- Parameters:
value
- tonal key key- See Also:
AudioSong.setKeyAlgorithm(String)
-
getKeyAlgorithm
public String getKeyAlgorithm()
Description copied from interface:AudioSong
Returns the name of the key algorithm. May beEntered
, if the key value was entered.- Specified by:
getKeyAlgorithm
in interfaceAudioSong
- Returns:
- key algorithm
-
setKeyAlgorithm
public void setKeyAlgorithm(String value)
Description copied from interface:AudioSong
Set the key algorithm. Should beEntered
, if the value was entered manually.- Specified by:
setKeyAlgorithm
in interfaceAudioSong
- Parameters:
value
- key algorithm
-
getSpectrum
public com.tagtraum.audiokern.timbre.BarkSpectrum getSpectrum()
Description copied from interface:AudioSong
Returns the bark spectrum.- Specified by:
getSpectrum
in interfaceAudioSong
- Returns:
- bark spectrum
- See Also:
AudioSong.getTempoTimbreColor()
-
setSpectrum
public void setSpectrum(com.tagtraum.audiokern.timbre.BarkSpectrum value)
Description copied from interface:AudioSong
Sets the bark spectrum.- Specified by:
setSpectrum
in interfaceAudioSong
- Parameters:
value
- bark spectrum
-
getTempoSpectrum
public com.tagtraum.audiokern.bpm.TempoSpectrum getTempoSpectrum()
Description copied from interface:AudioSong
Returns the tempo spectrum.- Specified by:
getTempoSpectrum
in interfaceAudioSong
- Returns:
- tempo spectrum
- See Also:
AudioSong.getTempoColor()
,AudioSong.getTempoTimbreColor()
-
setTempoSpectrum
public void setTempoSpectrum(com.tagtraum.audiokern.bpm.TempoSpectrum value)
Description copied from interface:AudioSong
Sets the tempo spectrum.- Specified by:
setTempoSpectrum
in interfaceAudioSong
- Parameters:
value
- tempo spectrum
-
setColor
public void setColor(Color value)
Description copied from interface:AudioSong
Sets the color.
-
getTempoColor
public Color getTempoColor()
Description copied from interface:AudioSong
Projection ofAudioSong.getTempoSpectrum()
to a color.- Specified by:
getTempoColor
in interfaceAudioSong
- Returns:
- color or null
-
setTempoColor
public void setTempoColor(Color value)
Description copied from interface:AudioSong
Sets this song's tempo color.- Specified by:
setTempoColor
in interfaceAudioSong
- Parameters:
value
- color
-
getTempoTimbreColor
public Color getTempoTimbreColor()
Description copied from interface:AudioSong
Projection ofAudioSong.getTempoSpectrum()
andAudioSong.getSpectrum()
to a color.- Specified by:
getTempoTimbreColor
in interfaceAudioSong
- Returns:
- color or null
-
setTempoTimbreColor
public void setTempoTimbreColor(Color value)
Description copied from interface:AudioSong
Sets this song's tempo-timbre color.- Specified by:
setTempoTimbreColor
in interfaceAudioSong
- Parameters:
value
- color
-
getBeatsPerMinute
public float getBeatsPerMinute()
Description copied from interface:AudioSong
Beats per minute (BPM).- Specified by:
getBeatsPerMinute
in interfaceAudioSong
- Returns:
- beats per minute
- See Also:
AudioSong.getTempo()
-
setBeatsPerMinute
public void setBeatsPerMinute(int value)
-
setBeatsPerMinute
public void setBeatsPerMinute(float value)
Description copied from interface:AudioSong
Sets beats per minute.- Specified by:
setBeatsPerMinute
in interfaceAudioSong
- Parameters:
value
- beats per minute- See Also:
AudioSong.setTempo(com.tagtraum.audiokern.bpm.Tempo)
-
getTempo
public com.tagtraum.audiokern.bpm.Tempo getTempo()
Description copied from interface:AudioSong
Returns tempo.
-
setTempo
public void setTempo(com.tagtraum.audiokern.bpm.Tempo value)
Description copied from interface:AudioSong
Sets the tempo.
-
getBeatsPerMinuteAlgorithm
public String getBeatsPerMinuteAlgorithm()
Description copied from interface:AudioSong
Returns the name of the algorithm used to determine the beats per minute (BPM).- Specified by:
getBeatsPerMinuteAlgorithm
in interfaceAudioSong
- Returns:
- algorithm name
-
setBeatsPerMinuteAlgorithm
public void setBeatsPerMinuteAlgorithm(String value)
Description copied from interface:AudioSong
Sets the BPM algorithm.- Specified by:
setBeatsPerMinuteAlgorithm
in interfaceAudioSong
- Parameters:
value
- bpm algorithm name
-
getTuningAlgorithm
public String getTuningAlgorithm()
Description copied from interface:AudioSong
The method the current tuning was created with.- Specified by:
getTuningAlgorithm
in interfaceAudioSong
- Returns:
- tuning algorithm
-
setTuningAlgorithm
public void setTuningAlgorithm(String value)
Description copied from interface:AudioSong
Sets the tuning algorithm the current tuning value was computed with.- Specified by:
setTuningAlgorithm
in interfaceAudioSong
- Parameters:
value
- tuning algorithm
-
getMoodAlgorithm
public String getMoodAlgorithm()
Description copied from interface:AudioSong
The method the associated mood value was created with.- Specified by:
getMoodAlgorithm
in interfaceAudioSong
- Returns:
- mood algorithm
-
setMoodAlgorithm
public void setMoodAlgorithm(String value)
Description copied from interface:AudioSong
Sets the method the current mood value was created with.- Specified by:
setMoodAlgorithm
in interfaceAudioSong
- Parameters:
value
- mood algorithm
-
getTimeSignatureAlgorithm
public String getTimeSignatureAlgorithm()
Description copied from interface:AudioSong
Method the time signature was computed with.- Specified by:
getTimeSignatureAlgorithm
in interfaceAudioSong
- Returns:
- algorithm the time signature was computed with
-
setTimeSignatureAlgorithm
public void setTimeSignatureAlgorithm(String value)
Description copied from interface:AudioSong
Sets the algorithm the time signature was computed with.- Specified by:
setTimeSignatureAlgorithm
in interfaceAudioSong
- Parameters:
value
- time signature algorithm
-
getBeatsAlgorithm
public String getBeatsAlgorithm()
Description copied from interface:AudioSong
Method the beats were computed with.- Specified by:
getBeatsAlgorithm
in interfaceAudioSong
- Returns:
- algorithm the beats were computed with
-
setBeatsAlgorithm
public void setBeatsAlgorithm(String value)
Description copied from interface:AudioSong
Sets the algorithm the beats were computed with.- Specified by:
setBeatsAlgorithm
in interfaceAudioSong
- Parameters:
value
- beats algorithm
-
getSegmentsAlgorithm
public String getSegmentsAlgorithm()
Description copied from interface:AudioSong
Method the segments were computed with.- Specified by:
getSegmentsAlgorithm
in interfaceAudioSong
- Returns:
- algorithm the segments were computed with
-
setSegmentsAlgorithm
public void setSegmentsAlgorithm(String value)
Description copied from interface:AudioSong
Sets the algorithm the segments were computed with.- Specified by:
setSegmentsAlgorithm
in interfaceAudioSong
- Parameters:
value
- segments algorithm
-
getSimilaritiesAlgorithm
public String getSimilaritiesAlgorithm()
Description copied from interface:AudioSong
Method the similarities were computed with.- Specified by:
getSimilaritiesAlgorithm
in interfaceAudioSong
- Returns:
- algorithm the similarities were computed with
-
setSimilaritiesAlgorithm
public void setSimilaritiesAlgorithm(String value)
Description copied from interface:AudioSong
Sets the algorithm the similarities were computed with.- Specified by:
setSimilaritiesAlgorithm
in interfaceAudioSong
- Parameters:
value
- similarities algorithm
-
getLanguage
public String getLanguage()
Description copied from interface:AudioSong
The language of the lyrics as ISO 639 three letter codes.- Specified by:
getLanguage
in interfaceAudioSong
- Returns:
- ISO 639 three letter language code
-
setLanguage
public void setLanguage(String value)
Description copied from interface:AudioSong
Sets the language as ISO 639 three letter code.- Specified by:
setLanguage
in interfaceAudioSong
- Parameters:
value
- ISO 639 three letter code
-
getFingerprint
public byte[] getFingerprint()
Description copied from interface:AudioSong
Acoustic fingerprint.- Specified by:
getFingerprint
in interfaceAudioSong
- Returns:
- acoustic fingerprint
-
setFingerprint
public void setFingerprint(byte[] fingerprint)
Description copied from interface:AudioSong
Sets the acoustic fingerprint.- Specified by:
setFingerprint
in interfaceAudioSong
- Parameters:
fingerprint
- fingerprint
-
getTrackIds
public Set<AudioId> getTrackIds()
Description copied from interface:AudioSong
Returns track ids.- Specified by:
getTrackIds
in interfaceAudioSong
- Returns:
- track ids
-
getAlbumIds
public Set<AudioId> getAlbumIds()
Description copied from interface:AudioSong
Get album ids.- Specified by:
getAlbumIds
in interfaceAudioSong
- Returns:
- album ids
-
getArtistIds
public Set<AudioId> getArtistIds()
Description copied from interface:AudioSong
Get artists ids.- Specified by:
getArtistIds
in interfaceAudioSong
- Returns:
- artist ids
-
getPlaylistId
public Long getPlaylistId()
The id of the playlist this song object stems from. Note that a song object may be contained in multiple playlists. This property is transient.- Returns:
- playlist id this song object stems from
- See Also:
getPlayLists()
-
setPlaylistId
public void setPlaylistId(Long value)
Typically not called by the user, but by the application- Parameters:
value
- playlistId- See Also:
getPlaylistId()
-
getLyrics
public String getLyrics()
Description copied from interface:AudioSong
Returns the lyrics.
-
setLyrics
public void setLyrics(String lyrics)
Description copied from interface:AudioSong
Sets lyrics.
-
getLyricsTermFrequencies
public List<TermFrequency> getLyricsTermFrequencies()
Description copied from interface:AudioSong
Terms in this song's lyrics along with their frequency. All terms are lowercase, regular ASCII punctuation has been removed.- Specified by:
getLyricsTermFrequencies
in interfaceAudioSong
- Returns:
- term frequencies
-
setTuning
public void setTuning(Integer value)
Description copied from interface:AudioSong
Sets tuning in cents (+-50).
-
setBeats
public void setBeats(Beats value)
Description copied from interface:AudioSong
Sets this song's beats.
-
getSegments
public Segments getSegments()
Description copied from interface:AudioSong
The song's segments.- Specified by:
getSegments
in interfaceAudioSong
- Returns:
- segments
-
setSegments
public void setSegments(Segments value)
Description copied from interface:AudioSong
Sets this song's segments.- Specified by:
setSegments
in interfaceAudioSong
- Parameters:
value
- segments
-
getSimilarities
public Similarities getSimilarities()
Description copied from interface:AudioSong
The song's similarities.- Specified by:
getSimilarities
in interfaceAudioSong
- Returns:
- similarities
-
setSimilarities
public void setSimilarities(Similarities value)
Description copied from interface:AudioSong
Sets this song's similarities.- Specified by:
setSimilarities
in interfaceAudioSong
- Parameters:
value
- similarities
-
getLoudness
public Loudness getLoudness()
Description copied from interface:AudioSong
The song's loudness curve.- Specified by:
getLoudness
in interfaceAudioSong
- Returns:
- loudness
-
setLoudness
public void setLoudness(Loudness value)
Description copied from interface:AudioSong
Sets this song's loudness curve.- Specified by:
setLoudness
in interfaceAudioSong
-
setMood
public void setMood(Mood value)
Description copied from interface:AudioSong
Sets this song's mood.
-
getMoodKeywords
public Set<String> getMoodKeywords()
Description copied from interface:AudioSong
Get raw mood keywords.- Specified by:
getMoodKeywords
in interfaceAudioSong
- Returns:
- mood keywords
-
setMoodKeywords
public void setMoodKeywords(Set<String> moodKeywords)
Persistent storage in database is not supported yet.- Specified by:
setMoodKeywords
in interfaceAudioSong
- Parameters:
moodKeywords
- mood keywords
-
setTimeSignature
public void setTimeSignature(TimeSignature value)
Description copied from interface:AudioSong
Sets this song's time signature.- Specified by:
setTimeSignature
in interfaceAudioSong
- Parameters:
value
- time signature
-
getTimeSignature
public TimeSignature getTimeSignature()
Description copied from interface:AudioSong
The song's time signature.- Specified by:
getTimeSignature
in interfaceAudioSong
- Returns:
- time signature
-
getMeasuresPerMinute
public float getMeasuresPerMinute()
Description copied from interface:AudioSong
Measures (bars) per minute. This value is computed fromAudioSong.getBeatsPerMinute()
andAudioSong.getTimeSignature()
. In essence BPM is divided by meter (time signature) numerator.- Specified by:
getMeasuresPerMinute
in interfaceAudioSong
- Returns:
- measures/bars per minute or zero, if either the time signature or the BPM is not known
-
getRMSMean
public Float getRMSMean()
Description copied from interface:AudioSong
Root mean square (RMS) of the signal's energy, averaged over windows of length ~23ms (actually 1024/44100 frames for a signal with sample rate 44.1kHz, i.e. 23.22ms) with a hopsize of half a window. Only the first 120 seconds of the audio are considered, the rest is discarded.- Specified by:
getRMSMean
in interfaceAudioSong
- Returns:
- average RMS for the first 120 seconds
- See Also:
TemporalFeaturePipelines.createAverageRootMeanSquarePipeline(String, int, int)
,Floats.rootMeanSquare(float[])
,AudioSong.getRMSStandardDeviation()
-
setRMSMean
public void setRMSMean(Float value)
Description copied from interface:AudioSong
Sets the average RMS for the first 120 seconds of this song.- Specified by:
setRMSMean
in interfaceAudioSong
- Parameters:
value
- averaged RMS- See Also:
AudioSong.getRMSMean()
-
getRMSStandardDeviation
public Float getRMSStandardDeviation()
Description copied from interface:AudioSong
Standard deviation of the root mean square energy values for windows of length ~23ms (actually 1024/44100 frames for a signal with sample rate 44.1kHz) with a hopsize of half a window. Only the first 120 seconds of the audio are considered, the rest is discarded.- Specified by:
getRMSStandardDeviation
in interfaceAudioSong
- Returns:
- standard deviation of the RMS for the first 120 seconds
- See Also:
Floats.rootMeanSquare(float[])
,AudioSong.getRMSMean()
-
setRMSStandardDeviation
public void setRMSStandardDeviation(Float value)
Description copied from interface:AudioSong
Sets the standard deviation of the root mean square (RMS).- Specified by:
setRMSStandardDeviation
in interfaceAudioSong
- Parameters:
value
- standard deviation of the RMS/window
-
getSpectralCentroidMean
public Float getSpectralCentroidMean()
Description copied from interface:AudioSong
Average of the spectral centroids computed for individual windows of length ~23.22ms with a hopsize of half a window length. Only the first 120 seconds of the signal are considered, the rest is discarded.- Specified by:
getSpectralCentroidMean
in interfaceAudioSong
- Returns:
- averaged spectral centroid
- See Also:
SpectralFeaturePipelines.createAverageSpectralCentroidPipeline(String, int, int, int)
-
setSpectralCentroidMean
public void setSpectralCentroidMean(Float value)
Description copied from interface:AudioSong
Sets the mean of the spectral centroids.- Specified by:
setSpectralCentroidMean
in interfaceAudioSong
- Parameters:
value
- averaged spectral centroids- See Also:
AudioSong.getSpectralCentroidMean()
-
getSpectralSpreadMean
public Float getSpectralSpreadMean()
Description copied from interface:AudioSong
Average of the spectral spread values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Specified by:
getSpectralSpreadMean
in interfaceAudioSong
- Returns:
- average spectral spread
- See Also:
SpectralFeaturePipelines.createAverageSpectralSpreadPipeline(String, int, int, int)
-
setSpectralSpreadMean
public void setSpectralSpreadMean(Float value)
Description copied from interface:AudioSong
Sets the average spectral spread.- Specified by:
setSpectralSpreadMean
in interfaceAudioSong
- Parameters:
value
- average spectral spread- See Also:
AudioSong.getSpectralSpreadMean()
-
getRelativeSpectralEntropyMean
public Float getRelativeSpectralEntropyMean()
Description copied from interface:AudioSong
Average of relative entropy values computed for windows of length 1.486s with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Specified by:
getRelativeSpectralEntropyMean
in interfaceAudioSong
- Returns:
- average relative entropy
- See Also:
AggregateFunctions.RELATIVE_ENTROPY
,SpectralFeaturePipelines.createAverageRelativeSpectralEntropyPipeline(String, int, int, int)
-
setRelativeSpectralEntropyMean
public void setRelativeSpectralEntropyMean(Float value)
Description copied from interface:AudioSong
Sets the average relative spectral entropy.- Specified by:
setRelativeSpectralEntropyMean
in interfaceAudioSong
- Parameters:
value
- average- See Also:
AudioSong.getRelativeSpectralEntropyMean()
-
setSpectralNoveltyMean
public void setSpectralNoveltyMean(Float value)
Description copied from interface:AudioSong
Sets the average spectral novelty.- Specified by:
setSpectralNoveltyMean
in interfaceAudioSong
- Parameters:
value
- average- See Also:
AudioSong.getSpectralNoveltyMean()
-
getSpectralNoveltyMean
public Float getSpectralNoveltyMean()
Description copied from interface:AudioSong
Average of the spectral novelty values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Specified by:
getSpectralNoveltyMean
in interfaceAudioSong
- Returns:
- average spectral novelty
-
setSpectralFluctuationPeak
public void setSpectralFluctuationPeak(Float value)
Description copied from interface:AudioSong
Peak of the spectral fluctuation values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Specified by:
setSpectralFluctuationPeak
in interfaceAudioSong
- Parameters:
value
- peak in an averaged fluctuation spectrum- See Also:
AudioSong.getSpectralFluctuationPeak()
-
getSpectralFluctuationPeak
public Float getSpectralFluctuationPeak()
Description copied from interface:AudioSong
Peak of the averaged spectral fluctuation values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Specified by:
getSpectralFluctuationPeak
in interfaceAudioSong
- Returns:
- peak of an averaged fluctuation spectrum
- See Also:
SpectralFeaturePipelines.createAverageSpectralFluctuationPipeline(String, int)
-
getSpectralFluxMean
public Float getSpectralFluxMean()
Description copied from interface:AudioSong
Average of the spectral flux values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Specified by:
getSpectralFluxMean
in interfaceAudioSong
- Returns:
- average spectral flux
- See Also:
SpectralFeaturePipelines.createAverageSpectralFluxPipeline(String, int, int, int)
-
setSpectralFluxMean
public void setSpectralFluxMean(Float value)
Description copied from interface:AudioSong
Sets the mean spectral flux.- Specified by:
setSpectralFluxMean
in interfaceAudioSong
- Parameters:
value
- average spectral flux- See Also:
AudioSong.getSpectralFluxMean()
-
getSpectralVariabilityMean
public Float getSpectralVariabilityMean()
Description copied from interface:AudioSong
Average of the spectral variability values computed for windows of length 23.22ms, with a hopsize of half a window. Only the first 120 seconds of the signal are considered, the rest is discarded.- Specified by:
getSpectralVariabilityMean
in interfaceAudioSong
- Returns:
- average spectral variability
- See Also:
SpectralFeaturePipelines.createAverageSpectralVariabilityPipeline(String, int, int, int)
-
setSpectralVariabilityMean
public void setSpectralVariabilityMean(Float value)
Description copied from interface:AudioSong
Sets the mean spectral variability.- Specified by:
setSpectralVariabilityMean
in interfaceAudioSong
- Parameters:
value
- average spectral variability- See Also:
AudioSong.getSpectralVariabilityMean()
-
setFrontCoverArtwork
public void setFrontCoverArtwork(File... frontCover)
Description copied from interface:AudioSong
Replace all front covers with the given files.- Specified by:
setFrontCoverArtwork
in interfaceAudioSong
- Parameters:
frontCover
- front cover- See Also:
AudioSong.setBackCoverArtwork(java.io.File...)
-
setBackCoverArtwork
public void setBackCoverArtwork(File... backCover)
Description copied from interface:AudioSong
Replace all back covers with the given files.- Specified by:
setBackCoverArtwork
in interfaceAudioSong
- Parameters:
backCover
- back cover- See Also:
AudioSong.setFrontCoverArtwork(java.io.File...)
-
getFrontCoverImage
public Image getFrontCoverImage()
Description copied from interface:AudioSong
Returns the first front cover image.- Specified by:
getFrontCoverImage
in interfaceAudioSong
- Returns:
- image or null
-
getBackCoverImage
public Image getBackCoverImage()
Description copied from interface:AudioSong
Returns the first front cover image.- Specified by:
getBackCoverImage
in interfaceAudioSong
- Returns:
- image or null
-
getArtworks
public AudioArtwork[] getArtworks()
Description copied from interface:AudioSong
Artwork belonging to this song.- Specified by:
getArtworks
in interfaceAudioSong
- Returns:
- array of artworks
-
addArtwork
public void addArtwork(AudioArtwork audioArtwork)
Description copied from interface:AudioSong
Adds an artwork/image to the audio song.- Specified by:
addArtwork
in interfaceAudioSong
- Parameters:
audioArtwork
- artwork
-
setArtworks
public void setArtworks(AudioArtwork... artworks)
Description copied from interface:AudioSong
Set artworks belonging to this track.- Specified by:
setArtworks
in interfaceAudioSong
- Parameters:
artworks
- artworks
-
-