Mac Developer Library

Developer

ITLibAlbum Class Reference

Options
Deployment Target:

On This Page

ITLibAlbum

The ITLibAlbum class provides information about an album in the iTunes library. Each track associated with the album is represented as an ITLibMediaItem in this framework.

A compilation is an album whose tracks come from more than one source/were created by different artists.

If an album is part of a multi-disc set, the discNumber property is the index of the album in the set.

To retrieve an ITLibAlbum instance, use the ITLibMediaItem album property.

  • Number of tracks in this album. (read-only)

    Declaration

    @property (readonly, nonatomic, assign) NSUInteger trackCount;

  • The title of this album. (read-only)

    Declaration

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

  • The title that iTunes uses when it sorts by album title. (read-only)

    Declaration

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

    Discussion

    If no sort title is specified, this property is nil and iTunes uses the value of the title property when it sorts by album title.

  • The rating of this album. (read-only)

    Declaration

    @property (readonly, nonatomic, assign) NSInteger rating;

  • Indicates whether the rating of this album was computed based upon the ratings of individual tracks in the album. (read-only)

    Declaration

    @property (readonly, nonatomic, assign, getter = isRatingComputed) BOOL ratingComputed;

    Discussion

    If the user rates tracks within this album individually, but has not assigned a specific rating for the album, the album rating is computed as the average of the rating of all tracks within the album (tracks with NO rating do not affect this average) and this property is true.

    If the user has rated this album, then this property is false.

    If the user has not rated the album and has not rated any tracks on this album, this property is false.

  • Whether this album is gapless. (read-only)

    Declaration

    @property (readonly, nonatomic, assign, getter = isGapless) BOOL gapless;

    Discussion

    A gapless album does not have silence (gap) between tracks.

  • The index (i.e. 1, 2, 3, etc.) of the disc within an album that is a multiple-disc set. (read-only)

    Declaration

    @property (readonly, nonatomic, assign) NSUInteger discNumber;

    Discussion

    If the album is not part of a multiple-disc set, this property is 0.

  • The number of discs in this multiple-disc set. (read-only)

    Declaration

    @property (readonly, nonatomic, assign) NSUInteger discCount;

  • Whether this album is a compilation. (read-only)

    Declaration

    @property (readonly, nonatomic, assign, getter = isCompilation) BOOL compilation;

    Discussion

    A compilation is an album made up of tracks created by multiple artists.

  • The name of the artist associated with this album. (read-only)

    Declaration

    @property (readonly, nonatomic, retain) ITLibArtist * albumArtist;

    Discussion

    If the artist is unknown, this property is nil.

  • The name that iTunes uses when it sorts by album artist. (read-only)

    Declaration

    @property (readonly, nonatomic, retain) ITLibArtist * sortAlbumArtist;

    Discussion

    If no sort album artist is specified, this property is nil and iTunes uses the value of the albumArtist property when it sorts by album artist.