iTunes COM Interface: IITURLTrack 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

IITURLTrack Interface Reference

Inheritance diagram for IITURLTrack:

IITTrack IITObject List of all members.

Detailed Description

Represents a URL track.

A URL track references a network audio stream.

Public Member Functions

Properties
HRESULT URL ([out, retval] BSTR *url)
 Returns the URL of the stream represented by this track.
HRESULT URL ([in] BSTR url)
 Set the URL of the stream represented by this track.
HRESULT Podcast ([out, retval] VARIANT_BOOL *isPodcast)
 Returns true if this track is a podcast track. If a podcast track is an IITURLTrack, the podcast episode has not been downloaded.
HRESULT Category ([out, retval] BSTR *category)
 Returns the category for the track.
HRESULT Category ([in] BSTR category)
 Sets the category for the track.
HRESULT Description ([out, retval] BSTR *description)
 Returns the description for the track.
HRESULT Description ([in] BSTR description)
 Sets the description for the track.
HRESULT LongDescription ([out, retval] BSTR *longDescription)
 Returns the long description for the track.
HRESULT LongDescription ([in] BSTR longDescription)
 Sets the long description for the track.
HRESULT AlbumRating ([out, retval] long *rating)
 Returns the user or computed rating of the album that this track belongs to (0 to 100). If the album rating has never been set, or has been set to 0, it will be computed based on the ratings of tracks in the album.
HRESULT AlbumRating ([in] long rating)
 Set the album rating of the album that this track belongs to (0 to 100). If the album rating is set to 0, it will be computed based on the ratings of tracks in the album.
HRESULT AlbumRatingKind ([out, retval] ITRatingKind *ratingKind)
 Returns the album rating kind. If the album rating has never been set, or has been set to 0, the kind is ITRatingKindComputed. Otherwise, the kind is ITRatingKindUser.
HRESULT RatingKind ([out, retval] ITRatingKind *ratingKind)
 Returns the track rating kind. If the track rating has never been set, or has been set to 0, the kind is ITRatingKindComputed. Otherwise, the kind is ITRatingKindUser.
HRESULT Playlists ([out, retval] IITPlaylistCollection **iPlaylistCollection)
 Returns a collection of playlists that contain the song that this track represents.
Methods
HRESULT UpdatePodcastFeed ()
 Update the podcast feed for this track. This is equivalent to the user choosing Update Podcast from the contextual menu for the podcast feed that contains this track.
HRESULT DownloadPodcastEpisode ()
 Start downloading the podcast episode that corresponds to this track. This is equivalent to the user clicking the Get button next to this track.
HRESULT Reveal ()
 Reveals the track in the main browser window.

Member Function Documentation

HRESULT IITURLTrack::AlbumRating (  [in] long  rating  ) 
 

Set the album rating of the album that this track belongs to (0 to 100). If the album rating is set to 0, it will be computed based on the ratings of tracks in the album.

Note:
This property is available in iTunes 7.4 and later (iTunes type library 1.10 and later).
Parameters:
rating The new album rating of the album that this track belongs to (0 to 100). If rating is outside this range, it will be pinned.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::AlbumRating (  [out, retval] long *  rating  ) 
 

Returns the user or computed rating of the album that this track belongs to (0 to 100). If the album rating has never been set, or has been set to 0, it will be computed based on the ratings of tracks in the album.

Note:
This property is available in iTunes 7.4 and later (iTunes type library 1.10 and later).
Parameters:
rating Returns the album rating of the album that this track belongs to (0 to 100).
Return values:
S_OK The operation was successful.
E_POINTER rating is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::AlbumRatingKind (  [out, retval] ITRatingKind *  ratingKind  ) 
 

Returns the album rating kind. If the album rating has never been set, or has been set to 0, the kind is ITRatingKindComputed. Otherwise, the kind is ITRatingKindUser.

Note:
This property is available in iTunes 7.4 and later (iTunes type library 1.10 and later).
Parameters:
ratingKind Returns the album rating kind.
Return values:
S_OK The operation was successful.
E_POINTER ratingKind is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::Category (  [in] BSTR  category  ) 
 

Sets the category for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
category The new category for the track.
Return values:
S_OK The operation was successful.
E_POINTER category is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::Category (  [out, retval] BSTR *  category  ) 
 

Returns the category for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
category Returns the category for the track.
Return values:
S_OK The operation was successful.
E_POINTER category is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::Description (  [in] BSTR  description  ) 
 

Sets the description for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
description The new description for the track.
Return values:
S_OK The operation was successful.
E_POINTER description is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::Description (  [out, retval] BSTR *  description  ) 
 

Returns the description for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
description Returns the description for the track.
Return values:
S_OK The operation was successful.
E_POINTER description is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::DownloadPodcastEpisode (   ) 
 

Start downloading the podcast episode that corresponds to this track. This is equivalent to the user clicking the Get button next to this track.

Note:
This method is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Return values:
S_OK The operation was successful.
E_INVALIDARG This track is not a podcast.
ITUNES_E_PODCASTSDISABLED Access to podcasts is disabled in the preferences.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::LongDescription (  [in] BSTR  longDescription  ) 
 

Sets the long description for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
longDescription The new long description for the track.
Return values:
S_OK The operation was successful.
E_POINTER longDescription is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::LongDescription (  [out, retval] BSTR *  longDescription  ) 
 

Returns the long description for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
longDescription Returns the long description for the track.
Return values:
S_OK The operation was successful.
E_POINTER longDescription is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::Playlists (  [out, retval] IITPlaylistCollection **  iPlaylistCollection  ) 
 

Returns a collection of playlists that contain the song that this track represents.

This is the same collection of playlists that are shown in the "Show in Playlist" contextual menu for a track, plus the specific playlist that contains this track.

A track represents a song in a single playlist, use IITTrack::Playlist() to get the specific playlist that contains this track.

Note:
This property is available in iTunes 7.7 and later (iTunes type library 1.11 and later).
Parameters:
iPlaylistCollection Collection of IITPlaylist objects.
Return values:
S_OK The operation was successful.
E_POINTER iPlaylistCollection is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::Podcast (  [out, retval] VARIANT_BOOL *  isPodcast  ) 
 

Returns true if this track is a podcast track. If a podcast track is an IITURLTrack, the podcast episode has not been downloaded.

Note:
This property is available in iTunes 4.9 and later (iTunes type library 1.4 and later).
Parameters:
isPodcast Returns true if this track is a podcast track.
Return values:
S_OK The operation was successful.
E_POINTER isPodcast is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::RatingKind (  [out, retval] ITRatingKind *  ratingKind  ) 
 

Returns the track rating kind. If the track rating has never been set, or has been set to 0, the kind is ITRatingKindComputed. Otherwise, the kind is ITRatingKindUser.

Note:
This property is available in iTunes 7.4 and later (iTunes type library 1.10 and later).
Parameters:
ratingKind Returns the track rating kind.
Return values:
S_OK The operation was successful.
E_POINTER ratingKind is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::Reveal (   ) 
 

Reveals the track 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 track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::UpdatePodcastFeed (   ) 
 

Update the podcast feed for this track. This is equivalent to the user choosing Update Podcast from the contextual menu for the podcast feed that contains this track.

Note:
This method is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Return values:
S_OK The operation was successful.
E_INVALIDARG This track is not a podcast.
ITUNES_E_PODCASTSDISABLED Access to podcasts is disabled in the preferences.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::URL (  [in] BSTR  url  ) 
 

Set the URL of the stream represented by this track.

Parameters:
url The URL of the stream represented by this track.
Return values:
S_OK The operation was successful.
E_POINTER url is NULL.
ITUNES_E_OBJECTLOCKED The URL cannot be modified.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITURLTrack::URL (  [out, retval] BSTR *  url  ) 
 

Returns the URL of the stream represented by this track.

Parameters:
url Returns the URL of the stream represented by this track.
Return values:
S_OK The operation was successful.
E_POINTER url is NULL.
ITUNES_E_OBJECTDELETED This track 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