Songbird / Development / Songbird Add-Ons API Documentation

sbIPlaybackHistoryEntry Interface Reference

List of all members.

Public Member Functions

AString getAnnotation (in AString aAnnotationId)
 Get an annotation by id.
boolean hasAnnotation (in AString aAnnotationId)
 Verify the presence of an annotation.
void setAnnotation (in AString aAnnotationId, in AString aAnnotationValue)
 Set an annotation on the entry.
void removeAnnotation (in AString aAnnotationId)
 Remove an annotation from the entry.
void init (in sbIMediaItem aItem, in long long aTimestamp, in long long aDuration, in sbIPropertyArray aAnnotations)
 Initialize a playback history entry.
void setEntryId (in long long aEntryId)
 Set the entry id.

Public Attributes

readonly attribute long long entryId
readonly attribute sbIMediaItem item
 The item that was played.
readonly attribute long long timestamp
 Timestamp indicating at which time the item started playing.
readonly attribute long long duration
 Duration of playback in microseconds.
readonly attribute sbIPropertyArray annotations
 Annotations to the entry. Annotations are properties.

Detailed Description

Definition at line 36 of file sbIPlaybackHistoryEntry.idl.


Member Function Documentation

AString sbIPlaybackHistoryEntry::getAnnotation ( in AString  aAnnotationId  ) 

Get an annotation by id.

Parameters:
aAnnotationId The annotation id.
Returns:
The annotation value.
Exceptions:
NS_ERROR_NOT_AVAILABLE when the annotation is not available.

boolean sbIPlaybackHistoryEntry::hasAnnotation ( in AString  aAnnotationId  ) 

Verify the presence of an annotation.

Parameters:
aAnnotationId The annotation id.
Return values:
true The annotation is present.
false The annotation is not available.

void sbIPlaybackHistoryEntry::setAnnotation ( in AString  aAnnotationId,
in AString  aAnnotationValue 
)

Set an annotation on the entry.

Parameters:
aAnnotationId The annotation id.
aAnnotationValue The annotation value.

void sbIPlaybackHistoryEntry::removeAnnotation ( in AString  aAnnotationId  ) 

Remove an annotation from the entry.

Parameters:
aAnnotationId The annotation id.

void sbIPlaybackHistoryEntry::init ( in sbIMediaItem  aItem,
in long long  aTimestamp,
in long long  aDuration,
in sbIPropertyArray  aAnnotations 
)

Initialize a playback history entry.

Parameters:
aItem The media item for the entry.
aTimestamp The time at which the item started playing.
aDuration The duration of playback for the item for this entry.
aAnnotations The annotations for the entry.
Note:
The timestamp is a standard UNIX style timestamp.

void sbIPlaybackHistoryEntry::setEntryId ( in long long  aEntryId  ) 

Set the entry id.

Note:
This method is for internal use only.


Member Data Documentation

readonly attribute long long sbIPlaybackHistoryEntry::entryId

Note:
This is not the _index_ of the entry.

Definition at line 42 of file sbIPlaybackHistoryEntry.idl.

readonly attribute long long sbIPlaybackHistoryEntry::timestamp

Timestamp indicating at which time the item started playing.

Note:
The timestamp is a usecs since the unix epoch.

Definition at line 53 of file sbIPlaybackHistoryEntry.idl.

readonly attribute long long sbIPlaybackHistoryEntry::duration

Duration of playback in microseconds.

Note:
This is optional.

Definition at line 59 of file sbIPlaybackHistoryEntry.idl.

readonly attribute sbIPropertyArray sbIPlaybackHistoryEntry::annotations

Annotations to the entry. Annotations are properties.

See also:
sbIProperty

Definition at line 65 of file sbIPlaybackHistoryEntry.idl.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:29:01 2009 for Songbird by  doxygen 1.5.2