sbIiTunesXMLParserListener Interface Reference

import"sbIiTunesXMLParserListener.idl";

Inheritance diagram for sbIiTunesXMLParserListener:

Collaboration diagram for sbIiTunesXMLParserListener:

Public Member Functions
void	onTopLevelProperties (in sbIStringMap aProperties)
void	onTrack (in sbIStringMap aProperties)
void	onTracksComplete ()
void	onPlaylist (in sbIStringMap aProperties, [array, size_is(aTrackIdsCount)] in long aTrackIds, in unsigned long aTrackIdsCount)
boolean	onError (in AString aErrorMessage)
void	onPlaylistsComplete ()
void	onProgress (in PRInt64 aBytesRead)

Detailed Description

This interface is called by sbIiTunesXMLParser as it discoveres interesting pieces in the iTunes XML file. You implement this interface in order to handle getting data from the iTunes XML file

Definition at line 39 of file sbIiTunesXMLParserListener.idl.

Member Function Documentation

boolean sbIiTunesXMLParserListener::onError

(

in AString

aErrorMessage

)

Called when an error is encountered

Parameters

aErrorMessage

Description of the error where it occured @RETURN return true if processing should continue or false to stop

void sbIiTunesXMLParserListener::onPlaylist	(	in sbIStringMap	aProperties,
		[array, size_is(aTrackIdsCount)] in long	aTrackIds,
		in unsigned long	aTrackIdsCount
	)

Called when a playlist has been processed

Parameters

a	Properties the collection of properties for the playlist
aTrackIds	is the list of track ID's for the playlist. These properties are read-only, QI'ing to sbIStringMapWritable is not permitted. And the properties object should not be used beyond this call.

void sbIiTunesXMLParserListener::onPlaylistsComplete

(

)

Called when all the playlists have been read

void sbIiTunesXMLParserListener::onProgress

(

in PRInt64

aBytesRead

)

Called for progress through the XML stream

void sbIiTunesXMLParserListener::onTopLevelProperties

(

in sbIStringMap

aProperties

)

Called when the top level properties have been processed

Parameters

aProperties

the collection of top level properties. These properties are read-only, QI'ing to sbIStringMapWritable is not permitted. And the properties object should not be used beyond this call.

void sbIiTunesXMLParserListener::onTrack

(

in sbIStringMap

aProperties

)

Called when a track has been processed

Parameters

aProperties

the collection of properties for the track. These properties are read-only, QI'ing to sbIStringMapWritable is not permitted. And the properties object should not be used beyond this call.

void sbIiTunesXMLParserListener::onTracksComplete

(

)

Called when all the tracks have been read

---

The documentation for this interface was generated from the following file:

• /home/martin/dev/nightingale-hacking/components/mediaimport/library/itunes/public/sbIiTunesXMLParserListener.idl