Module tagtraum.obstunes

Package com.tagtraum.macos.itunes

Interface UserPlaylist

All Superinterfaces:

Item, Playlist, Reference

All Known Subinterfaces:

FolderPlaylist

@Plural("user playlists")
@Code("cUsP")
@Name("user playlist")
@Inherits("playlist")
public interface UserPlaylist
extends Reference, Playlist

Custom playlists created by the user.

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	countFileTracks()
int	countFileTracks(String filter)
default int	countSharedTracks()
int	countSharedTracks(String filter)
default int	countUrlTracks()
int	countUrlTracks(String filter)
FileTrack	getFileTrack(int index)
FileTrack	getFileTrack(Id id)
default FileTrack[]	getFileTracks()
FileTrack[]	getFileTracks(String filter)
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
SharedTrack	getSharedTrack(int index)
SharedTrack	getSharedTrack(Id id)
default SharedTrack[]	getSharedTracks()
SharedTrack[]	getSharedTracks(String filter)
UrlTrack	getUrlTrack(int index)
UrlTrack	getUrlTrack(Id id)
default UrlTrack[]	getUrlTracks()
UrlTrack[]	getUrlTracks(String filter)
boolean	isGenius()	Is this a Genius Playlist?
boolean	isShared()	Is this playlist shared?
boolean	isSmart()	Is this a Smart Playlist?
void	setShared(boolean shared)	Is this playlist shared?

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

getFileTracks

@Kind("element")
@Type("file track")
default FileTrack[] getFileTracks()

Returns:

an array of all FileTracks

getFileTracks

@Kind("element")
@Type("file track")
FileTrack[] getFileTracks(String filter)

Parameters:

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

Returns:

an array of all FileTracks

getFileTrack

@Kind("element")
@Type("file track")
FileTrack getFileTrack(int index)

Parameters:

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

Returns:

the FileTrack at the requested index

getFileTrack

@Kind("element")
@Type("file track")
FileTrack getFileTrack(Id id)

Parameters:

id - id of the item

Returns:

the FileTrack with the requested id

countFileTracks

@Kind("element")
@Type("file track")
default int countFileTracks()

Returns:

number of all FileTracks

countFileTracks

@Kind("element")
@Type("file track")
int countFileTracks(String filter)

Parameters:

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

Returns:

the number of elements that pass the filter

getUrlTracks

@Kind("element")
@Type("URL track")
default UrlTrack[] getUrlTracks()

Returns:

an array of all UrlTracks

getUrlTracks

@Kind("element")
@Type("URL track")
UrlTrack[] getUrlTracks(String filter)

Parameters:

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

Returns:

an array of all UrlTracks

getUrlTrack

@Kind("element")
@Type("URL track")
UrlTrack getUrlTrack(int index)

Parameters:

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

Returns:

the UrlTrack at the requested index

getUrlTrack

@Kind("element")
@Type("URL track")
UrlTrack getUrlTrack(Id id)

Parameters:

id - id of the item

Returns:

the UrlTrack with the requested id

countUrlTracks

@Kind("element")
@Type("URL track")
default int countUrlTracks()

Returns:

number of all UrlTracks

countUrlTracks

@Kind("element")
@Type("URL track")
int countUrlTracks(String filter)

Parameters:

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

Returns:

the number of elements that pass the filter

getSharedTracks

@Kind("element")
@Type("shared track")
default SharedTrack[] getSharedTracks()

Returns:

an array of all SharedTracks

getSharedTracks

@Kind("element")
@Type("shared track")
SharedTrack[] getSharedTracks(String filter)

Parameters:

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

Returns:

an array of all SharedTracks

getSharedTrack

@Kind("element")
@Type("shared track")
SharedTrack getSharedTrack(int index)

Parameters:

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

Returns:

the SharedTrack at the requested index

getSharedTrack

@Kind("element")
@Type("shared track")
SharedTrack getSharedTrack(Id id)

Parameters:

id - id of the item

Returns:

the SharedTrack with the requested id

countSharedTracks

@Kind("element")
@Type("shared track")
default int countSharedTracks()

Returns:

number of all SharedTracks

countSharedTracks

@Kind("element")
@Type("shared track")
int countSharedTracks(String filter)

Parameters:

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

Returns:

the number of elements that pass the filter

isShared

@Code("pShr")
@Kind("property")
@Name("shared")
@Type("boolean")
boolean isShared()

Is this playlist shared?

Returns:

property value

setShared

@Code("pShr")
@Kind("property")
@Name("shared")
@Type("boolean")
void setShared(boolean shared)

Is this playlist shared?

Parameters:

shared - new property value

isSmart

@Code("pSmt")
@Kind("property")
@Name("smart")
@Type("boolean")
boolean isSmart()

Is this a Smart Playlist?

Returns:

property value

isGenius

@Code("pGns")
@Kind("property")
@Name("genius")
@Type("boolean")
boolean isGenius()

Is this a Genius Playlist?

Returns:

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