Module tagtraum.obstunes

Package com.tagtraum.macos.itunes

Interface AudioCdPlaylist

All Superinterfaces:

Item, Playlist, Reference

@Plural("audio CD playlists")
@Code("cCDP")
@Name("audio CD playlist")
@Inherits("playlist")
public interface AudioCdPlaylist
extends Reference, Playlist

A playlist representing an audio CD.

Author:

JaplScript 3.4.12

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
default int	countAudioCdTracks()
int	countAudioCdTracks(String filter)
String	getArtist()	The artist of the CD.
AudioCdTrack	getAudioCdTrack(int index)
AudioCdTrack	getAudioCdTrack(Id id)
default AudioCdTrack[]	getAudioCdTracks()
AudioCdTrack[]	getAudioCdTracks(String filter)
String	getComposer()	The composer of the CD.
int	getDiscCount()	The total number of discs in this CD’s album.
int	getDiscNumber()	The index of this CD disc in the source album.
String	getGenre()	The genre of the CD.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
int	getYear()	The year the album was recorded/released.
boolean	isCompilation()	Is this CD a compilation album?
void	setArtist(String artist)	The artist of the CD.
void	setCompilation(boolean compilation)	Is this CD a compilation album?
void	setComposer(String composer)	The composer of the CD.
void	setDiscCount(int discCount)	The total number of discs in this CD’s album.
void	setDiscNumber(int discNumber)	The index of this CD disc in the source album.
void	setGenre(String genre)	The genre of the CD.
void	setYear(int year)	The year the album was recorded/released.

Methods inherited from interface com.tagtraum.macos.itunes.Item

getContainer, getId, getIndex, getKlass, getPersistentId

Methods inherited from interface com.tagtraum.macos.itunes.Playlist

countArtworks, countArtworks, countTracks, countTracks, getArtwork, getArtwork, getArtworks, getArtworks, getDescription, getDuration, getName, getParent, getSize, getSongRepeat, getSpecialKind, getTime, getTrack, getTrack, getTracks, getTracks, isDisliked, isLoved, isShuffle, isVisible, setDescription, setDisliked, setLoved, setName, setShuffle, setSongRepeat

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getAudioCdTracks

@Kind("element")
@Type("audio CD track")
default AudioCdTrack[] getAudioCdTracks()

Returns:

an array of all AudioCdTracks

getAudioCdTracks

@Kind("element")
@Type("audio CD track")
AudioCdTrack[] getAudioCdTracks(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all AudioCdTracks

getAudioCdTrack

@Kind("element")
@Type("audio CD track")
AudioCdTrack getAudioCdTrack(int index)

Parameters:

index - index into the element list (zero-based)

Returns:

the AudioCdTrack at the requested index

getAudioCdTrack

@Kind("element")
@Type("audio CD track")
AudioCdTrack getAudioCdTrack(Id id)

Parameters:

id - id of the item

Returns:

the AudioCdTrack with the requested id

countAudioCdTracks

@Kind("element")
@Type("audio CD track")
default int countAudioCdTracks()

Returns:

number of all AudioCdTracks

countAudioCdTracks

@Kind("element")
@Type("audio CD track")
int countAudioCdTracks(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getArtist

@Code("pArt")
@Kind("property")
@Name("artist")
@Type("text")
String getArtist()

The artist of the CD.

Returns:

property value

setArtist

@Code("pArt")
@Kind("property")
@Name("artist")
@Type("text")
void setArtist(String artist)

The artist of the CD.

Parameters:

artist - new property value

isCompilation

@Code("pAnt")
@Kind("property")
@Name("compilation")
@Type("boolean")
boolean isCompilation()

Is this CD a compilation album?

Returns:

property value

setCompilation

@Code("pAnt")
@Kind("property")
@Name("compilation")
@Type("boolean")
void setCompilation(boolean compilation)

Is this CD a compilation album?

Parameters:

compilation - new property value

getComposer

@Code("pCmp")
@Kind("property")
@Name("composer")
@Type("text")
String getComposer()

The composer of the CD.

Returns:

property value

setComposer

@Code("pCmp")
@Kind("property")
@Name("composer")
@Type("text")
void setComposer(String composer)

The composer of the CD.

Parameters:

composer - new property value

getDiscCount

@Code("pDsC")
@Kind("property")
@Name("disc count")
@Type("integer")
int getDiscCount()

The total number of discs in this CD’s album.

Returns:

property value

setDiscCount

@Code("pDsC")
@Kind("property")
@Name("disc count")
@Type("integer")
void setDiscCount(int discCount)

The total number of discs in this CD’s album.

Parameters:

discCount - new property value

getDiscNumber

@Code("pDsN")
@Kind("property")
@Name("disc number")
@Type("integer")
int getDiscNumber()

The index of this CD disc in the source album.

Returns:

property value

setDiscNumber

@Code("pDsN")
@Kind("property")
@Name("disc number")
@Type("integer")
void setDiscNumber(int discNumber)

The index of this CD disc in the source album.

Parameters:

discNumber - new property value

getGenre

@Code("pGen")
@Kind("property")
@Name("genre")
@Type("text")
String getGenre()

The genre of the CD.

Returns:

property value

setGenre

@Code("pGen")
@Kind("property")
@Name("genre")
@Type("text")
void setGenre(String genre)

The genre of the CD.

Parameters:

genre - new property value

getYear

@Code("pYr ")
@Kind("property")
@Name("year")
@Type("integer")
int getYear()

The year the album was recorded/released.

Returns:

property value

setYear

@Code("pYr ")
@Kind("property")
@Name("year")
@Type("integer")
void setYear(int year)

The year the album was recorded/released.

Parameters:

year - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Specified by:

getProperties in interface Item

Specified by:

getProperties in interface Playlist

Returns:

Map containing all properties