Public Member Functions | Public Attributes | List of all members
sbIPlaybackHistoryEntry Interface Reference

import"sbIPlaybackHistoryEntry.idl";

Inheritance diagram for sbIPlaybackHistoryEntry:
[legend]
Collaboration diagram for sbIPlaybackHistoryEntry:
[legend]

Public Member Functions

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

Public Attributes

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

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
aAnnotationIdThe annotation id.
Returns
The annotation value.
Exceptions
NS_ERROR_NOT_AVAILABLEwhen the annotation is not available.
boolean sbIPlaybackHistoryEntry::hasAnnotation ( in AString  aAnnotationId)

Verify the presence of an annotation.

Parameters
aAnnotationIdThe annotation id.
Return values
trueThe annotation is present.
falseThe annotation is not available.
void sbIPlaybackHistoryEntry::init ( in sbIMediaItem  aItem,
in long long  aTimestamp,
in long long  aDuration,
in sbIPropertyArray  aAnnotations 
)

Initialize a playback history entry.

Parameters
aItemThe media item for the entry.
aTimestampThe time at which the item started playing.
aDurationThe duration of playback for the item for this entry.
aAnnotationsThe annotations for the entry.
Note
The timestamp is a standard UNIX style timestamp.
void sbIPlaybackHistoryEntry::removeAnnotation ( in AString  aAnnotationId)

Remove an annotation from the entry.

Parameters
aAnnotationIdThe annotation id.
void sbIPlaybackHistoryEntry::setAnnotation ( in AString  aAnnotationId,
in AString  aAnnotationValue 
)

Set an annotation on the entry.

Parameters
aAnnotationIdThe annotation id.
aAnnotationValueThe annotation value.
void sbIPlaybackHistoryEntry::setEntryId ( in long long  aEntryId)

Set the entry id.

Note
This method is for internal use only.

Member Data Documentation

readonly attribute sbIPropertyArray sbIPlaybackHistoryEntry::annotations

Annotations to the entry. Annotations are properties.

See Also
sbIProperty

Definition at line 65 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 long long sbIPlaybackHistoryEntry::entryId
Note
This is not the index of the entry.

Definition at line 42 of file sbIPlaybackHistoryEntry.idl.

readonly attribute sbIMediaItem sbIPlaybackHistoryEntry::item

The item that was played.

Definition at line 47 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.

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