sbIMediaInspector Interface Reference

import"sbIMediaInspector.idl";

Inheritance diagram for sbIMediaInspector:

Collaboration diagram for sbIMediaInspector:

Public Member Functions
sbIMediaFormat	inspectMediaURI (in AString aURI)
sbIMediaFormat	inspectMedia (in sbIMediaItem aMediaItem)
void	inspectMediaURIAsync (in AString aURI)
void	inspectMediaAsync (in sbIMediaItem aMediaItem)

Public Attributes
readonly attribute sbIMediaFormat	mediaFormat

Detailed Description

This is the interface to the media inspector service. It provides information on the format of a media item

Definition at line 212 of file sbIMediaInspector.idl.

Member Function Documentation

sbIMediaFormat sbIMediaInspector::inspectMedia

(

in sbIMediaItem

aMediaItem

)

This method is used to retrieve the media format information for a given Songbird media item, synchronously. This method MUST NOT be used from the main thread.

Parameters

aMediaItem

The item to retrieve the media format

Returns

the media format for the media item. If the service is unable to obtain the format NS_NOT_AVAILABLE exception is "thrown"

void sbIMediaInspector::inspectMediaAsync

(

in sbIMediaItem

aMediaItem

)

This method is used to retrieve the media format information for a given Songbird media item, asynchronously. This method may be used from any thread. Before calling this, the caller should QI this object to sbIJobProgress, and listen for the job to complete. Once complete (and successful), the caller may read the 'mediaFormat' attribute.

Parameters

aMediaItem

The item to retrieve the media format

sbIMediaFormat sbIMediaInspector::inspectMediaURI

(

in AString

aURI

)

This method is used to retrieve the media format information for a given filename, synchronously. This method MUST NOT be used from the main thread.

Parameters

aURI	The item's URI as a string to retrieve the media format

Returns

the media format for the media item. If the service is unable to obtain the format NS_NOT_AVAILABLE exception is "thrown"

void sbIMediaInspector::inspectMediaURIAsync

(

in AString

aURI

)

This method is used to retrieve the media format information for a given filename, asynchronously. This method may be used from any thread. Before calling this, the caller should QI this object to sbIJobProgress, and listen for the job to complete. Once complete (and successful), the caller may read the 'mediaFormat' attribute.

Parameters

param

aURI The item's URI as a string to retrieve the media format

Member Data Documentation

readonly attribute sbIMediaFormat sbIMediaInspector::mediaFormat

The media format from the most recent call to inspectMedia or inspectMediaAsync, if that has completed successfully. Otherwise null.

Definition at line 264 of file sbIMediaInspector.idl.

---

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

• /home/martin/dev/nightingale-hacking/components/mediacore/base/public/sbIMediaInspector.idl