sbIIdentityService Interface Reference

A service to provide identifiers for mediaitems. More...

import"sbIIdentityService.idl";

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

Public Member Functions

AString hashString (in AString aString)
 HashString Hashes the param string using the same method as used when generating metadata hash identities. The methods described below calculate an identity by passing this function a metadata property string of the form: contentType|trackName|artistName|albumName|genre for audio and contentType|trackName|artistName|albumName|genre for video to this method and this format should also be used for any other identity calculations. More...
 
AString calculateIdentityForMediaItem (in sbIMediaItem aMediaItem)
 CalculateIdentityForMediaItem Generates an identifier for the param aMediaItem and that identifier is returned. If media item's content type is not video or audio or the hash property values were not found or empty, a void string is returned. More...
 
AString calculateIdentityForBag (in sbILocalDatabaseResourcePropertyBag aPropertyBag)
 CalculateIdentityForBag - Generates an identifier for the properties contained within the param aPropertyBag and that identifier is returned. If content type is not video or audio or the hash property values were not found or empty a void string is returned. More...
 
void saveIdentityToMediaItem (in sbIMediaItem aMediaItem, in AString aIdentity)
 SaveIdentityToMediaItem - Saves the param aIdentity to the param aMediaItem's propertybag which will automatically flush that value to the database. More...
 
void saveIdentityToBag (in sbILocalDatabaseResourcePropertyBag aPropertyBag, in AString aIdentity)
 SaveIdentityToBag - Saves the param aIdentity to the propertybag which will automatically flush that value to the database for later retrieval. More...
 

Detailed Description

A service to provide identifiers for mediaitems.

Definition at line 35 of file sbIIdentityService.idl.

Member Function Documentation

AString sbIIdentityService::calculateIdentityForBag ( in sbILocalDatabaseResourcePropertyBag  aPropertyBag)

CalculateIdentityForBag - Generates an identifier for the properties contained within the param aPropertyBag and that identifier is returned. If content type is not video or audio or the hash property values were not found or empty a void string is returned.

Parameters
aPropertyBagThe propertybag containing properties that should be used to calculate a metadata hash identity
Returns
An identifier for the properties within the param aPropertyBag. This may be a void string if there are no property values to hash.
AString sbIIdentityService::calculateIdentityForMediaItem ( in sbIMediaItem  aMediaItem)

CalculateIdentityForMediaItem Generates an identifier for the param aMediaItem and that identifier is returned. If media item's content type is not video or audio or the hash property values were not found or empty, a void string is returned.

Parameters
aMediaItemThe mediaitem whose identity should be calculated and returned
Returns
An identifier for the param aMediaItem
AString sbIIdentityService::hashString ( in AString  aString)

HashString Hashes the param string using the same method as used when generating metadata hash identities. The methods described below calculate an identity by passing this function a metadata property string of the form: contentType|trackName|artistName|albumName|genre for audio and contentType|trackName|artistName|albumName|genre for video to this method and this format should also be used for any other identity calculations.

Parameters
aStringThe string that will be hashed
Returns
The hash of the param aString
void sbIIdentityService::saveIdentityToBag ( in sbILocalDatabaseResourcePropertyBag  aPropertyBag,
in AString  aIdentity 
)

SaveIdentityToBag - Saves the param aIdentity to the propertybag which will automatically flush that value to the database for later retrieval.

Parameters
aPropertyBagThe propertybag that will be associated with the param aIdentity
aIdentityThe identity that should be saved in aPropertyBag
void sbIIdentityService::saveIdentityToMediaItem ( in sbIMediaItem  aMediaItem,
in AString  aIdentity 
)

SaveIdentityToMediaItem - Saves the param aIdentity to the param aMediaItem's propertybag which will automatically flush that value to the database.

Parameters
aMediaItemThe mediaitem that will be associated with the param aIdentity
aIdentityThe metadata hash identifier for the param aMediaItem

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