sbIMediaItem Interface Reference

Interface that defines a single item of media in the system. More...

import"sbIMediaItem.idl";

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

Public Member Functions

void testIsURIAvailable (in nsIObserver aObserver)
 Test if this media item is available for playback. More...
 
nsIChannel openInputStreamAsync (in nsIStreamListener aListener, in nsISupports aContext)
 Asynchronously get an input stream to the content of the media item. More...
 
nsIInputStream openInputStream ()
 Synchronously get an input stream to the content of the media item. More...
 
nsIOutputStream openOutputStream ()
 Get an output stream to the content of the media item. More...
 
AString toString ()
 Get a string representation of the media item, useful for debugging. More...
 
- Public Member Functions inherited from sbILibraryResource
AString getProperty (in AString aID)
 Get the value of a property of this resource. More...
 
void setProperty (in AString aID, in AString aValue)
 Set the value of a property on this resource. More...
 
sbIPropertyArray getProperties ([optional] in sbIPropertyArray aPropertyIDs)
 Get properties from this resource in a property array. More...
 
void setProperties (in sbIPropertyArray aProperties)
 Sets the properties and values in the supplied property array to this resource. This works as if you called setProperty on each property in the array. More...
 
boolean equals (in sbILibraryResource aOtherLibraryResource)
 Tests the equality of two library resources. More...
 

Public Attributes

readonly attribute sbILibrary library
 The library that this media item is contained in. More...
 
readonly attribute boolean isMutable
 Can the media item be changed? More...
 
readonly attribute
sbIMediaItemController 
itemController
 An interface to the media item controller (if any) that determines this item's availability for playback. More...
 
attribute long long mediaCreated
 Creation time of the media item as a unix timestamp. More...
 
attribute long long mediaUpdated
 Last modification time of the media item as a unix timestamp. More...
 
attribute nsIURI contentSrc
 A nsIURI that resolves to the content of the media item. More...
 
attribute long long contentLength
 Size (in bytes) of the content of the media item. More...
 
attribute AString contentType
 Content type of the content of the media item, typically a mime type (should this be renamed?) More...
 
- Public Attributes inherited from sbILibraryResource
readonly attribute AString guid
 The guid of this resource. More...
 
readonly attribute long long created
 The creation time of this resource as a unix timestamp. More...
 
readonly attribute long long updated
 The last update time of this resource as a unix timestamp. More...
 
readonly attribute
nsIStringEnumerator 
propertyIDs
 Returns a string enumerator of the IDs of all the properties set on this resource. More...
 
readonly attribute boolean userEditable
 True if users should be allowed to modify the resource. More...
 

Detailed Description

Interface that defines a single item of media in the system.

The Songbird concept of a media item is the abstraction of a renderable piece of media. A media item contains content as well as metadata about the content. A media item must be associated with a particular library.

See Also
sbILibrary, sbIMediaList

Definition at line 53 of file sbIMediaItem.idl.

Member Function Documentation

nsIInputStream sbIMediaItem::openInputStream ( )

Synchronously get an input stream to the content of the media item.

Returns
The input stream
nsIChannel sbIMediaItem::openInputStreamAsync ( in nsIStreamListener  aListener,
in nsISupports  aContext 
)

Asynchronously get an input stream to the content of the media item.

Note
If the listener can also QI to an nsIInterfaceRequestor, it will be assigned to the internal channel's notificationCallbacks property.
Parameters
aListenerProvide an nsIStreamListener to receive streaming data.
aContextValue passed to the stream listener to provide context.
nsIOutputStream sbIMediaItem::openOutputStream ( )

Get an output stream to the content of the media item.

Returns
The output stream
void sbIMediaItem::testIsURIAvailable ( in nsIObserver  aObserver)

Test if this media item is available for playback.

Parameters
aObserverAn observer that is notified with the item's availabilty
AString sbIMediaItem::toString ( )

Get a string representation of the media item, useful for debugging.

Returns
A string representation of the media item

Member Data Documentation

attribute long long sbIMediaItem::contentLength

Size (in bytes) of the content of the media item.

Definition at line 147 of file sbIMediaItem.idl.

attribute nsIURI sbIMediaItem::contentSrc

A nsIURI that resolves to the content of the media item.

Definition at line 130 of file sbIMediaItem.idl.

attribute AString sbIMediaItem::contentType

Content type of the content of the media item, typically a mime type (should this be renamed?)

Definition at line 165 of file sbIMediaItem.idl.

readonly attribute boolean sbIMediaItem::isMutable

Can the media item be changed?

Definition at line 73 of file sbIMediaItem.idl.

readonly attribute sbIMediaItemController sbIMediaItem::itemController

An interface to the media item controller (if any) that determines this item's availability for playback.

Definition at line 79 of file sbIMediaItem.idl.

readonly attribute sbILibrary sbIMediaItem::library

The library that this media item is contained in.

Definition at line 62 of file sbIMediaItem.idl.

attribute long long sbIMediaItem::mediaCreated

Creation time of the media item as a unix timestamp.

Note that this is the creation time of the media item itself, not the creation time of the item's content

Definition at line 98 of file sbIMediaItem.idl.

attribute long long sbIMediaItem::mediaUpdated

Last modification time of the media item as a unix timestamp.

Note that this is the last modification time of the media item itself, not the creation time of the item's content

Definition at line 115 of file sbIMediaItem.idl.


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