iTunes COM Interface: IITAudioCDPlaylist Interface Reference

iTunes COM

previous page next page
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

IITAudioCDPlaylist Interface Reference

Inheritance diagram for IITAudioCDPlaylist:

IITPlaylist IITObject List of all members.

Detailed Description

Represents an audio CD playlist.

An audio CD playlist is always associated with an IITSource of kind ITSourceKindAudioCD.

You can retrieve all the playlists defined for a source using IITSource::Playlists().

Public Member Functions

Properties
HRESULT Artist ([out, retval] BSTR *artist)
 Returns the audio CD's artist.
HRESULT Compilation ([out, retval] VARIANT_BOOL *isCompiliation)
 Returns true if this audio CD is a compilation album.
HRESULT Composer ([out, retval] BSTR *composer)
 Returns the audio CD's composer.
HRESULT DiscCount ([out, retval] long *discCount)
 Returns the total number of discs in this CD's album.
HRESULT DiscNumber ([out, retval] long *discNumber)
 Returns the index of the CD disc in the source album.
HRESULT Genre ([out, retval] BSTR *genre)
 Returns the audio CD's genre.
HRESULT Year ([out, retval] long *year)
 Returns the year the album was recorded/released.
Methods
HRESULT Reveal ()
 Reveals the CD playlist in the main browser window.

Member Function Documentation

HRESULT IITAudioCDPlaylist::Artist (  [out, retval] BSTR *  artist  ) 
 

Returns the audio CD's artist.

Parameters:
artist Returns the audio CD's artist.
Return values:
S_OK The operation was successful.
E_POINTER artist is NULL.
ITUNES_E_OBJECTDELETED This playlist has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITAudioCDPlaylist::Compilation (  [out, retval] VARIANT_BOOL *  isCompiliation  ) 
 

Returns true if this audio CD is a compilation album.

Parameters:
isCompiliation Returns true if this audio CD is a compilation album.
Return values:
S_OK The operation was successful.
E_POINTER isCompiliation is NULL.
ITUNES_E_OBJECTDELETED This playlist has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITAudioCDPlaylist::Composer (  [out, retval] BSTR *  composer  ) 
 

Returns the audio CD's composer.

Parameters:
composer Returns the audio CD's composer.
Return values:
S_OK The operation was successful.
E_POINTER composer is NULL.
ITUNES_E_OBJECTDELETED This playlist has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITAudioCDPlaylist::DiscCount (  [out, retval] long *  discCount  ) 
 

Returns the total number of discs in this CD's album.

Parameters:
discCount Returns the total number of discs in this CD's album.
Return values:
S_OK The operation was successful.
E_POINTER discCount is NULL.
ITUNES_E_OBJECTDELETED This playlist has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITAudioCDPlaylist::DiscNumber (  [out, retval] long *  discNumber  ) 
 

Returns the index of the CD disc in the source album.

Parameters:
discNumber Returns the index of the CD disc in the source album.
Return values:
S_OK The operation was successful.
E_POINTER discNumber is NULL.
ITUNES_E_OBJECTDELETED This playlist has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITAudioCDPlaylist::Genre (  [out, retval] BSTR *  genre  ) 
 

Returns the audio CD's genre.

Parameters:
genre Returns the audio CD's genre.
Return values:
S_OK The operation was successful.
E_POINTER genre is NULL.
ITUNES_E_OBJECTDELETED This playlist has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITAudioCDPlaylist::Reveal (   ) 
 

Reveals the CD playlist in the main browser window.

Note:
This method is available in iTunes 7.4 and later (iTunes type library 1.10 and later).
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTDELETED This playlist has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITAudioCDPlaylist::Year (  [out, retval] long *  year  ) 
 

Returns the year the album was recorded/released.

Parameters:
year Returns the year the album was recorded/released.
Return values:
S_OK The operation was successful.
E_POINTER year is NULL.
ITUNES_E_OBJECTDELETED This playlist has been deleted.
E_FAIL An unexpected error occurred.

Generated on Fri Mar 13 12:50:54 2009 for iTunes 8.1.0.52
©2004-2007 Apple Computer, Inc.

previous page start next page