Mac Developer Library

Developer

ITLibPlaylist Class Reference

Options
Deployment Target:

On This Page

ITLibPlaylist

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Not Applicable Not Applicable

The ITLibPlaylist class describes a playlist in the iTunes library. A playlist is a collection of media items (tracks). Playlists may be created and organized manually by the user or automatically generated by iTunes. Playlists are modeled as media entities. Each contains a unique identifier and a set of properties. Playlists may form a hierarchical structure. In those cases, the parentID property of ITLibPlaylist returns the persistent ID of the parent playlist.

  • visible visible Property

    Whether this playlist is visible to the user in iTunes. (read-only)

    Declaration

    Objective-C

    @property (readonly, nonatomic, assign, getter=isVisible) BOOL visible;

    Discussion

    Some playlists are hidden, used and maintained by iTunes but never displayed as playlists to the user. Tracks in a playlist that is not visible can still be visible.

  • parentID parentID Property

    The unique persistent identifier of this playlist’s parent playlist. (read-only)

    Declaration

    Objective-C

    @property (readonly, nonatomic, retain) NSNumber * parentID;

    Discussion

    If this playlist does not have a parent, this property is nil.

  • name name Property

    The name or title of this playlist. (read-only)

    Declaration

    Objective-C

    @property (readonly, nonatomic, copy) NSString * name;

  • master master Property

    Whether this playlist represents the entire iTunes library. (read-only)

    Declaration

    Objective-C

    @property (readonly, nonatomic, assign, getter=isMaster) BOOL master;

  • items items Property

    The media items (tracks) in this playlist. (read-only)

    Declaration

    Objective-C

    @property (readonly, nonatomic, retain) NSArray * items;

  • The distinguished kind of this playlist. (read-only)

    Declaration

    Objective-C

    @property (readonly, nonatomic, assign) ITLibDistinguishedPlaylistKind distinguishedKind;

    Discussion

    Distinguished playlists are special playlists, often generated by iTunes to organize media items inside the library. If the playlist is not a distinguished playlist, this property returns ITLibDistinguishedPlaylistKindNone.

  • This property is reserved for future use. (read-only)

    Declaration

    Objective-C

    @property (readonly, nonatomic, assign, getter=isAllItemsPlaylist) BOOL allItemsPlaylist;

    Discussion

    This property always returns true.

  • These constants specify the possible kinds of playlists.

    Declaration

    Objective-C

    enum { ITLibDistinguishedPlaylistKindNone = 0, ITLibDistinguishedPlaylistKindMovies = 1, ITLibDistinguishedPlaylistKindTVShows = 2, ITLibDistinguishedPlaylistKindMusic = 3, ITLibDistinguishedPlaylistKindBooks = 4, ITLibDistinguishedPlaylistKindRingtones = 5, ITLibDistinguishedPlaylistKindPodcasts = 7, ITLibDistinguishedPlaylistKindVoiceMemos = 14, ITLibDistinguishedPlaylistKindPurchases = 16, ITLibDistinguishedPlaylistKindiTunesU = 26, ITLibDistinguishedPlaylistKind90sMusic = 42, ITLibDistinguishedPlaylistKindMyTopRated = 43, ITLibDistinguishedPlaylistKindTop25MostPlayed = 44, ITLibDistinguishedPlaylistKindRecentlyPlayed = 45, ITLibDistinguishedPlaylistKindRecentlyAdded = 46, ITLibDistinguishedPlaylistKindMusicVideos = 47, ITLibDistinguishedPlaylistKindClassicalMusic = 48, };

    Constants

    • ITLibDistinguishedPlaylistKindNone

      ITLibDistinguishedPlaylistKindNone

      The playlist is not a distinguished playlist.

    • ITLibDistinguishedPlaylistKindMovies

      ITLibDistinguishedPlaylistKindMovies

      The playlist contains all the movies in the iTunes Library.

    • ITLibDistinguishedPlaylistKindTVShows

      ITLibDistinguishedPlaylistKindTVShows

      The playlists contains all the TV shows in the iTunes Library.

    • ITLibDistinguishedPlaylistKindMusic

      ITLibDistinguishedPlaylistKindMusic

      The playlist contains all the music items in the iTunes Library.

    • ITLibDistinguishedPlaylistKindBooks

      ITLibDistinguishedPlaylistKindBooks

      The playlist contains all the books in the iTunes Library

    • ITLibDistinguishedPlaylistKindRingtones

      ITLibDistinguishedPlaylistKindRingtones

      The playlist contains all the ringtones in the iTunes Library.

    • ITLibDistinguishedPlaylistKindPodcasts

      ITLibDistinguishedPlaylistKindPodcasts

      The playlist contains all the podcasts in the iTunes library

    • ITLibDistinguishedPlaylistKindVoiceMemos

      ITLibDistinguishedPlaylistKindVoiceMemos

      The playlist contains all the user’s voice memos that are in the iTunes library.

    • ITLibDistinguishedPlaylistKindApplications

      ITLibDistinguishedPlaylistKindApplications

      The playlist contains all the iOS applications of the user in iTunes.

    • ITLibDistinguishedPlaylistKindPurchases

      ITLibDistinguishedPlaylistKindPurchases

      The playlist contains all the user's purchases in the iTunes Store.

    • ITLibDistinguishedPlaylistKindiTunesU

      ITLibDistinguishedPlaylistKindiTunesU

      The playlist contains the user's iTunesU items.

    • ITLibDistinguishedPlaylistKind90sMusic

      ITLibDistinguishedPlaylistKind90sMusic

      The playlist is the default 90's music iTunes playlist.

    • ITLibDistinguishedPlaylistKindMyTopRated

      ITLibDistinguishedPlaylistKindMyTopRated

      The playlist is the default Top Rated smart playlist generated by iTunes.

    • ITLibDistinguishedPlaylistKindTop25MostPlayed

      ITLibDistinguishedPlaylistKindTop25MostPlayed

      The playlist is the default 25 Most Played smart playlist generated by iTunes.

    • ITLibDistinguishedPlaylistKindRecentlyPlayed

      ITLibDistinguishedPlaylistKindRecentlyPlayed

      The playlist is the default Recently Played smart playlist generated by iTunes .

    • ITLibDistinguishedPlaylistKindRecentlyAdded

      ITLibDistinguishedPlaylistKindRecentlyAdded

      The playlist is the default Recently Added smart playlist generated by iTunes.

    • ITLibDistinguishedPlaylistKindMusicVideos

      ITLibDistinguishedPlaylistKindMusicVideos

      The playlist is the default Music Videos smart playlist generated by iTunes.

    • ITLibDistinguishedPlaylistKindClassicalMusic

      ITLibDistinguishedPlaylistKindClassicalMusic

      The playlist is the default Classical Music smart playlist generated by iTunes.