Songbird / Development / Songbird Add-Ons API Documentation

sbIDeviceCapabilities Interface Reference

[UNIMPLEMENTED UNTIL AFTER 0.3] More...

import "sbIDeviceCapabilities.idl";

List of all members.

Public Member Functions

void setFunctionTypes ([array, size_is(aFunctionTypesCount)] in PRUint32 aFunctionTypes, in unsigned long aFunctionTypesCount)
 Sets an array of function types.
void setEventTypes ([array, size_is(aEventTypesCount)] in unsigned long aEventTypes, in unsigned long aEventTypesCount)
 Sets an array of event types.
void addContentTypes (in PRUint32 aFunctionType,[array, size_is(aContentTypesCount)] in unsigned long aContentTypes, in unsigned long aContentTypesCount)
 Add an array of content types for a function type.
void addFormats (in PRUint32 aContentType,[array, size_is(aFormatsCount)] in string aFormats, in unsigned long aFormatsCount)
 Add an array of formats for a content type.
void initDone ()
 Indicates that the initialization is complete, the add and set functions above will no longer affect the data.
void getSupportedFunctionTypes (out unsigned long aArrayCount,[retval, array, size_is(aArrayCount)] out PRUint32 aFunctionTypes)
void getSupportedContentTypes (in PRUint32 aFunctionType, out unsigned long aArrayCount,[retval, array, size_is(aArrayCount)] out PRUint32 aContentTypes)
void getSupportedFormats (in PRUint32 aContentType, out unsigned long aArrayCount,[retval, array, size_is(aArrayCount)] out string aSupportedFormats)
void getSupportedEvents (out unsigned long aArrayCount,[retval, array, size_is(aArrayCount)] out unsigned long aSupportedEvents)

Public Attributes

const PRUint32 FUNCTION_UNKNOWN = 0x00
const PRUint32 FUNCTION_DEVICE = 0x01
const PRUint32 FUNCTION_AUDIO_PLAYBACK = 0x02
const PRUint32 FUNCTION_AUDIO_CAPTURE = 0x03
const PRUint32 FUNCTION_IMAGE_DISPLAY = 0x04
const PRUint32 FUNCTION_IMAGE_CAPTURE = 0x05
const PRUint32 FUNCTION_VIDEO_PLAYBACK = 0x06
const PRUint32 FUNCTION_VIDEO_CAPTURE = 0x07
const PRUint32 FUNCTION_CLIENT_DEFINED = 0x80000000
const PRUint32 CONTENT_UNKNOWN = 0x00
const PRUint32 CONTENT_FILE = 0x01
const PRUint32 CONTENT_FOLDER = 0x02
const PRUint32 CONTENT_AUDIO = 0x03
const PRUint32 CONTENT_IMAGE = 0x04
const PRUint32 CONTENT_VIDEO = 0x05
const PRUint32 CONTENT_PLAYLIST = 0x06
const PRUint32 CONTENT_ALBUM = 0x07
const PRUint32 CONTENT_CLIENT_DEFINED = 0x80000000


Detailed Description

[UNIMPLEMENTED UNTIL AFTER 0.3]

Note:
Implementations of this interface must be threadsafe.

Definition at line 38 of file sbIDeviceCapabilities.idl.


Member Function Documentation

void sbIDeviceCapabilities::setFunctionTypes ( [array, size_is(aFunctionTypesCount)] in PRUint32  aFunctionTypes,
in unsigned long  aFunctionTypesCount 
)

Sets an array of function types.

Parameters:
aFunctionTypes and array of function types
aFunctionTypesCount length of aFunctionTypes array

void sbIDeviceCapabilities::setEventTypes ( [array, size_is(aEventTypesCount)] in unsigned long  aEventTypes,
in unsigned long  aEventTypesCount 
)

Sets an array of event types.

Parameters:
aEventTypes an array of event types
aEventCount length of aEventTypes array

void sbIDeviceCapabilities::addContentTypes ( in PRUint32  aFunctionType,
[array, size_is(aContentTypesCount)] in unsigned long  aContentTypes,
in unsigned long  aContentTypesCount 
)

Add an array of content types for a function type.

Parameters:
aFunctionType Function type these content types fall under
aContentTypes an array of content types for aFunctionType
aContentTypesCount length of aContentTypes array

void sbIDeviceCapabilities::addFormats ( in PRUint32  aContentType,
[array, size_is(aFormatsCount)] in string  aFormats,
in unsigned long  aFormatsCount 
)

Add an array of formats for a content type.

Parameters:
aContentType Content type these formats fall under
aFormats an array of formats for aContentType
aFormatsCount length of aFormats array

void sbIDeviceCapabilities::getSupportedFunctionTypes ( out unsigned long  aArrayCount,
[retval, array, size_is(aArrayCount)] out PRUint32  aFunctionTypes 
)

An array of nsISupportsPRUint32 values defined above.

void sbIDeviceCapabilities::getSupportedContentTypes ( in PRUint32  aFunctionType,
out unsigned long  aArrayCount,
[retval, array, size_is(aArrayCount)] out PRUint32  aContentTypes 
)

An array of nsISupportsPRUint32 values defined above.

void sbIDeviceCapabilities::getSupportedFormats ( in PRUint32  aContentType,
out unsigned long  aArrayCount,
[retval, array, size_is(aArrayCount)] out string  aSupportedFormats 
)

Returns an array of sbIContentTypeFormat objects.

void sbIDeviceCapabilities::getSupportedEvents ( out unsigned long  aArrayCount,
[retval, array, size_is(aArrayCount)] out unsigned long  aSupportedEvents 
)

An array of nsISupportsPRUint32 values defined in sbIDeviceEvent.idl


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