Source (Obstunes 0.9.7, Java API for iTunes generated by JaplScript 3.4.12)

All Superinterfaces:: Item, Reference

@Plural("sources")
@Code("cSrc")
@Name("source")
@Inherits("item")
public interface Source
extends Reference, Item

A music source (music library, CD, device, etc.).

Author:: JaplScript 3.4.12

Field Summary

Fields
Modifier and Type Field Description

static TypeClass CLASS

Fields
Modifier and Type	Field	Description
`static TypeClass`	`CLASS`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default int`	`countAudioCdPlaylists()`
`int`	`countAudioCdPlaylists(String filter)`
`default int`	`countLibraryPlaylists()`
`int`	`countLibraryPlaylists(String filter)`
`default int`	`countPlaylists()`
`int`	`countPlaylists(String filter)`
`default int`	`countRadioTunerPlaylists()`
`int`	`countRadioTunerPlaylists(String filter)`
`default int`	`countSubscriptionPlaylists()`
`int`	`countSubscriptionPlaylists(String filter)`
`default int`	`countUserPlaylists()`
`int`	`countUserPlaylists(String filter)`
`AudioCdPlaylist`	`getAudioCdPlaylist(int index)`
`AudioCdPlaylist`	`getAudioCdPlaylist(Id id)`
`default AudioCdPlaylist[]`	`getAudioCdPlaylists()`
`AudioCdPlaylist[]`	`getAudioCdPlaylists(String filter)`
`long`	`getCapacity()`	The total size of the source if it has a fixed size.
`long`	`getFreeSpace()`	The free space on the source if it has a fixed size.
`Esrc`	`getKind()`
`LibraryPlaylist`	`getLibraryPlaylist(int index)`
`LibraryPlaylist`	`getLibraryPlaylist(Id id)`
`default LibraryPlaylist[]`	`getLibraryPlaylists()`
`LibraryPlaylist[]`	`getLibraryPlaylists(String filter)`
`Playlist`	`getPlaylist(int index)`
`Playlist`	`getPlaylist(Id id)`
`default Playlist[]`	`getPlaylists()`
`Playlist[]`	`getPlaylists(String filter)`
`Map<String,Object>`	`getProperties()`	Returns all properties for an instance of this class.
`RadioTunerPlaylist`	`getRadioTunerPlaylist(int index)`
`RadioTunerPlaylist`	`getRadioTunerPlaylist(Id id)`
`default RadioTunerPlaylist[]`	`getRadioTunerPlaylists()`
`RadioTunerPlaylist[]`	`getRadioTunerPlaylists(String filter)`
`SubscriptionPlaylist`	`getSubscriptionPlaylist(int index)`
`SubscriptionPlaylist`	`getSubscriptionPlaylist(Id id)`
`default SubscriptionPlaylist[]`	`getSubscriptionPlaylists()`
`SubscriptionPlaylist[]`	`getSubscriptionPlaylists(String filter)`
`UserPlaylist`	`getUserPlaylist(int index)`
`UserPlaylist`	`getUserPlaylist(Id id)`
`default UserPlaylist[]`	`getUserPlaylists()`
`UserPlaylist[]`	`getUserPlaylists(String filter)`

Methods inherited from interface com.tagtraum.macos.itunes.Item
getContainer, getId, getIndex, getKlass, getName, getPersistentId, setName

Methods inherited from interface com.tagtraum.japlscript.Reference
cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

- Field Detail
  - CLASS
```
static final TypeClass CLASS
```
- Method Detail
  - getAudioCdPlaylists
```
@Kind("element")
@Type("audio CD playlist")
default AudioCdPlaylist[] getAudioCdPlaylists()
```
    Returns:
    
    an array of all AudioCdPlaylists
  - getAudioCdPlaylists
```
@Kind("element")
@Type("audio CD playlist")
AudioCdPlaylist[] getAudioCdPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all AudioCdPlaylists
  - getAudioCdPlaylist
```
@Kind("element")
@Type("audio CD playlist")
AudioCdPlaylist getAudioCdPlaylist(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the AudioCdPlaylist at the requested index
  - getAudioCdPlaylist
```
@Kind("element")
@Type("audio CD playlist")
AudioCdPlaylist getAudioCdPlaylist(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the AudioCdPlaylist with the requested id
  - countAudioCdPlaylists
```
@Kind("element")
@Type("audio CD playlist")
default int countAudioCdPlaylists()
```
    Returns:
    
    number of all AudioCdPlaylists
  - countAudioCdPlaylists
```
@Kind("element")
@Type("audio CD playlist")
int countAudioCdPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getLibraryPlaylists
```
@Kind("element")
@Type("library playlist")
default LibraryPlaylist[] getLibraryPlaylists()
```
    Returns:
    
    an array of all LibraryPlaylists
  - getLibraryPlaylists
```
@Kind("element")
@Type("library playlist")
LibraryPlaylist[] getLibraryPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all LibraryPlaylists
  - getLibraryPlaylist
```
@Kind("element")
@Type("library playlist")
LibraryPlaylist getLibraryPlaylist(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the LibraryPlaylist at the requested index
  - getLibraryPlaylist
```
@Kind("element")
@Type("library playlist")
LibraryPlaylist getLibraryPlaylist(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the LibraryPlaylist with the requested id
  - countLibraryPlaylists
```
@Kind("element")
@Type("library playlist")
default int countLibraryPlaylists()
```
    Returns:
    
    number of all LibraryPlaylists
  - countLibraryPlaylists
```
@Kind("element")
@Type("library playlist")
int countLibraryPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getPlaylists
```
@Kind("element")
@Type("playlist")
default Playlist[] getPlaylists()
```
    Returns:
    
    an array of all Playlists
  - getPlaylists
```
@Kind("element")
@Type("playlist")
Playlist[] getPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Playlists
  - getPlaylist
```
@Kind("element")
@Type("playlist")
Playlist getPlaylist(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Playlist at the requested index
  - getPlaylist
```
@Kind("element")
@Type("playlist")
Playlist getPlaylist(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Playlist with the requested id
  - countPlaylists
```
@Kind("element")
@Type("playlist")
default int countPlaylists()
```
    Returns:
    
    number of all Playlists
  - countPlaylists
```
@Kind("element")
@Type("playlist")
int countPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getRadioTunerPlaylists
```
@Kind("element")
@Type("radio tuner playlist")
default RadioTunerPlaylist[] getRadioTunerPlaylists()
```
    Returns:
    
    an array of all RadioTunerPlaylists
  - getRadioTunerPlaylists
```
@Kind("element")
@Type("radio tuner playlist")
RadioTunerPlaylist[] getRadioTunerPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all RadioTunerPlaylists
  - getRadioTunerPlaylist
```
@Kind("element")
@Type("radio tuner playlist")
RadioTunerPlaylist getRadioTunerPlaylist(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the RadioTunerPlaylist at the requested index
  - getRadioTunerPlaylist
```
@Kind("element")
@Type("radio tuner playlist")
RadioTunerPlaylist getRadioTunerPlaylist(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the RadioTunerPlaylist with the requested id
  - countRadioTunerPlaylists
```
@Kind("element")
@Type("radio tuner playlist")
default int countRadioTunerPlaylists()
```
    Returns:
    
    number of all RadioTunerPlaylists
  - countRadioTunerPlaylists
```
@Kind("element")
@Type("radio tuner playlist")
int countRadioTunerPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getSubscriptionPlaylists
```
@Kind("element")
@Type("subscription playlist")
default SubscriptionPlaylist[] getSubscriptionPlaylists()
```
    Returns:
    
    an array of all SubscriptionPlaylists
  - getSubscriptionPlaylists
```
@Kind("element")
@Type("subscription playlist")
SubscriptionPlaylist[] getSubscriptionPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all SubscriptionPlaylists
  - getSubscriptionPlaylist
```
@Kind("element")
@Type("subscription playlist")
SubscriptionPlaylist getSubscriptionPlaylist(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the SubscriptionPlaylist at the requested index
  - getSubscriptionPlaylist
```
@Kind("element")
@Type("subscription playlist")
SubscriptionPlaylist getSubscriptionPlaylist(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the SubscriptionPlaylist with the requested id
  - countSubscriptionPlaylists
```
@Kind("element")
@Type("subscription playlist")
default int countSubscriptionPlaylists()
```
    Returns:
    
    number of all SubscriptionPlaylists
  - countSubscriptionPlaylists
```
@Kind("element")
@Type("subscription playlist")
int countSubscriptionPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getUserPlaylists
```
@Kind("element")
@Type("user playlist")
default UserPlaylist[] getUserPlaylists()
```
    Returns:
    
    an array of all UserPlaylists
  - getUserPlaylists
```
@Kind("element")
@Type("user playlist")
UserPlaylist[] getUserPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all UserPlaylists
  - getUserPlaylist
```
@Kind("element")
@Type("user playlist")
UserPlaylist getUserPlaylist(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the UserPlaylist at the requested index
  - getUserPlaylist
```
@Kind("element")
@Type("user playlist")
UserPlaylist getUserPlaylist(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the UserPlaylist with the requested id
  - countUserPlaylists
```
@Kind("element")
@Type("user playlist")
default int countUserPlaylists()
```
    Returns:
    
    number of all UserPlaylists
  - countUserPlaylists
```
@Kind("element")
@Type("user playlist")
int countUserPlaylists(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getCapacity
```
@Code("capa")
@Kind("property")
@Name("capacity")
@Type("double integer")
long getCapacity()
```
    The total size of the source if it has a fixed size.
    
    Returns:
    
    property value
  - getFreeSpace
```
@Code("frsp")
@Kind("property")
@Name("free space")
@Type("double integer")
long getFreeSpace()
```
    The free space on the source if it has a fixed size.
    
    Returns:
    
    property value
  - getKind
```
@Code("pKnd")
@Kind("property")
@Name("kind")
@Type("eSrc")
Esrc getKind()
```
    Returns:
    
    property value
  - getProperties
```
Map<String,Object> getProperties()
```
    Returns all properties for an instance of this class.
    
    Specified by:
    
    getProperties in interface Item
    
    Returns:
    
    Map containing all properties

Interface Source

Field Summary

Method Summary

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

Methods inherited from interface com.tagtraum.japlscript.Reference

Field Detail

CLASS

Method Detail

getAudioCdPlaylists

getAudioCdPlaylists

getAudioCdPlaylist

getAudioCdPlaylist

countAudioCdPlaylists

countAudioCdPlaylists

getLibraryPlaylists

getLibraryPlaylists

getLibraryPlaylist

getLibraryPlaylist

countLibraryPlaylists

countLibraryPlaylists

getPlaylists

getPlaylists

getPlaylist

getPlaylist

countPlaylists

countPlaylists

getRadioTunerPlaylists

getRadioTunerPlaylists

getRadioTunerPlaylist

getRadioTunerPlaylist

countRadioTunerPlaylists

countRadioTunerPlaylists

getSubscriptionPlaylists

getSubscriptionPlaylists

getSubscriptionPlaylist

getSubscriptionPlaylist

countSubscriptionPlaylists

countSubscriptionPlaylists

getUserPlaylists

getUserPlaylists

getUserPlaylist

getUserPlaylist

countUserPlaylists

countUserPlaylists

getCapacity

getFreeSpace

getKind

getProperties