[UNIMPLEMENTED UNTIL AFTER 0.3] More...

import"sbIDeviceCapabilities.idl";

Inheritance diagram for sbIDeviceCapabilities:

Collaboration diagram for sbIDeviceCapabilities:

Public Member Functions
void	init ()
	Initialize the device capabilities, sets up to be able to accept the set and add functions below. More...

void	setFunctionTypes ([array, size_is(aFunctionTypesCount)] in PRUint32 aFunctionTypes, in unsigned long aFunctionTypesCount)
	Sets an array of function types. More...

void	setEventTypes ([array, size_is(aEventTypesCount)] in unsigned long aEventTypes, in unsigned long aEventTypesCount)
	Sets an array of event types. More...

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. More...

void	addMimeTypes (in PRUint32 aContentType, [array, size_is(aMimeTypesCount)] in string aMimeTypes, in unsigned long aMimeTypesCount)
	Add an array of mime types for a content type. More...

void	AddFormatType (in PRUint32 aContentType, in AString aMimeType, in nsISupports aFormatType)
	Add a constraint to a mime type. More...

void	AddPreferredFormatType (in PRUint32 aContentType, in AString aMimeType, in nsISupports aFormatType)
	Add a preferred constraint to a mime type (these are used for target formats when transcoding. More...

void	addCapabilities (in sbIDeviceCapabilities aCapabilities)
	Add the capabilities specified by aCapabilities. More...

void	configureDone ()
	Indicates that the configuration is complete, the add and set functions above will no longer affect the data. More...

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	getSupportedMimeTypes (in PRUint32 aContentType, out unsigned long aArrayCount, [retval, array, size_is(aArrayCount)] out string aSupportedMimeTypes)

void	getFormatTypes (in PRUint32 aContentType, in AString aMimeType, out unsigned long aArrayCount, [retval, array, size_is(aArrayCount)] out nsISupports aSupportedFormats)

void	getPreferredFormatTypes (in PRUint32 aContentType, in AString aMimeType, out unsigned long aArrayCount, [retval, array, size_is(aArrayCount)] out nsISupports aPreferredFormats)

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

boolean	supportsContent (in PRUint32 aFunctionType, in PRUint32 aContentType)

nsIStringEnumerator	getSupportedFileExtensions (in sbIDevice aDevice, in PRUint32 aContentType)

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_MAX_TYPES = 0x08

const PRUint32	CONTENT_CLIENT_DEFINED = 0x80000000

Detailed Description

[UNIMPLEMENTED UNTIL AFTER 0.3]

Note: Implementations of this interface must be threadsafe.

Definition at line 527 of file sbIDeviceCapabilities.idl.

Member Function Documentation

void sbIDeviceCapabilities::addCapabilities ( in sbIDeviceCapabilities aCapabilities )

Add the capabilities specified by aCapabilities.

Parameters

aCapabilities Set of capabilities to add

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::AddFormatType	(	in PRUint32	aContentType,
		in AString	aMimeType,
		in nsISupports	aFormatType
	)

Add a constraint to a mime type.

Parameters

aContentType	the content type this format falls under, see the CONTENT_* constants below.
aMimeType	the mime type we're adding a constraint for. This must correspond to a mime type previously added by addMimeTypes
aFormatType	the object describing the format type. For example it it could be a sbIAudioFormatType or a sbIImageFormatType

void sbIDeviceCapabilities::addMimeTypes	(	in PRUint32	aContentType,
		[array, size_is(aMimeTypesCount)] in string	aMimeTypes,
		in unsigned long	aMimeTypesCount
	)

Add an array of mime types for a content type.

Parameters

aContentType	Content type these mime types fall under
aMimeTypes	an array of mime types for aContentType
aMimeTypesCount	length of aMimeTypes array

void sbIDeviceCapabilities::AddPreferredFormatType	(	in PRUint32	aContentType,
		in AString	aMimeType,
		in nsISupports	aFormatType
	)

Add a preferred constraint to a mime type (these are used for target formats when transcoding.

Parameters

aContentType	the content type this format falls under, see the CONTENT_* constants below.
aMimeType	the mime type we're adding a constraint for. This must correspond to a mime type previously added by addMimeTypes
aFormatType	the object describing the format type. For example it it could be a sbIAudioFormatType or a sbIImageFormatType

void sbIDeviceCapabilities::configureDone ( )

Indicates that the configuration is complete, the add and set functions above will no longer affect the data.

void sbIDeviceCapabilities::getFormatTypes	(	in PRUint32	aContentType,
		in AString	aMimeType,
		out unsigned long	aArrayCount,
		[retval, array, size_is(aArrayCount)] out nsISupports	aSupportedFormats
	)

Returns an array of constraint objects (sbIVideoFormatType, sbIAudioFormatType, sbIImageFormatType, depending on the content type requested) for this mime type and type of content.

void sbIDeviceCapabilities::getPreferredFormatTypes	(	in PRUint32	aContentType,
		in AString	aMimeType,
		out unsigned long	aArrayCount,
		[retval, array, size_is(aArrayCount)] out nsISupports	aPreferredFormats
	)

Returns an array of constraint objects (sbIVideoFormatType, sbIAudioFormatType, sbIImageFormatType, depending on the content type requested) for this mime type and type of content.

These specify the preferred format for this type of data. If transcoding is required, it will always transcode to parameters matching one of these constraint objects. If an implementation has no specific knowledge of preferred values, it should simply return the same information here as from getFormatTypes.

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::getSupportedEvents	(	out unsigned long	aArrayCount,
		[retval, array, size_is(aArrayCount)] out unsigned long	aSupportedEvents
	)

Returns an array of nsISupportsPRUint32 values defined in sbIDeviceEvent.idl

nsIStringEnumerator sbIDeviceCapabilities::getSupportedFileExtensions	(	in sbIDevice	aDevice,
		in PRUint32	aContentType
	)

Get all the file extensions of the content type specified by aContentType supported by the device specified by aDevice.

Parameters

aDevice	Device from which to get file extensions.
aContentType	Content type for the file extensions to get.

Returns: all file extensions the device supports

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

An array of nsISupportsPRUint32 values defined above.

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

Returns an array of mime types supported for this type of content.

void sbIDeviceCapabilities::init ( )

Initialize the device capabilities, sets up to be able to accept the set and add functions below.

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::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

boolean sbIDeviceCapabilities::supportsContent	(	in PRUint32	aFunctionType,
		in PRUint32	aContentType
	)

Whether the device supports the content type specified by aContentType

Parameters

aFunctionType	the function type to check.
aContentType	the content type to check.

Returns: true if the content type is supported.

Member Data Documentation

const PRUint32 sbIDeviceCapabilities::CONTENT_ALBUM = 0x07

Definition at line 648 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::CONTENT_AUDIO = 0x03

Definition at line 644 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::CONTENT_CLIENT_DEFINED = 0x80000000

Definition at line 654 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::CONTENT_FILE = 0x01

Definition at line 642 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::CONTENT_FOLDER = 0x02

Definition at line 643 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::CONTENT_IMAGE = 0x04

Definition at line 645 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::CONTENT_MAX_TYPES = 0x08

Definition at line 649 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::CONTENT_PLAYLIST = 0x06

Definition at line 647 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::CONTENT_UNKNOWN = 0x00

Definition at line 641 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::CONTENT_VIDEO = 0x05

Definition at line 646 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::FUNCTION_AUDIO_CAPTURE = 0x03

Definition at line 619 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::FUNCTION_AUDIO_PLAYBACK = 0x02

Definition at line 618 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::FUNCTION_CLIENT_DEFINED = 0x80000000

Definition at line 628 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::FUNCTION_DEVICE = 0x01

Definition at line 617 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::FUNCTION_IMAGE_CAPTURE = 0x05

Definition at line 621 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::FUNCTION_IMAGE_DISPLAY = 0x04

Definition at line 620 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::FUNCTION_UNKNOWN = 0x00

Definition at line 616 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::FUNCTION_VIDEO_CAPTURE = 0x07

Definition at line 623 of file sbIDeviceCapabilities.idl.

const PRUint32 sbIDeviceCapabilities::FUNCTION_VIDEO_PLAYBACK = 0x06

Definition at line 622 of file sbIDeviceCapabilities.idl.

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

/home/martin/dev/nightingale-hacking/components/devices/base/public/sbIDeviceCapabilities.idl

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation