import"sbIDeviceCapabilities.idl";

Inheritance diagram for sbIDevCapVideoStream:

Collaboration diagram for sbIDevCapVideoStream:

Public Member Functions
void	initialize (in ACString aType, in nsIArray aExplicitSizes, in sbIDevCapRange aWidths, in sbIDevCapRange aHeights, in nsIArray aSupportedPARs, in boolean aSupportedPARsIsRange, in nsIArray aSupportedFrameRates, in boolean aSupportedFrameRatesIsRange, in sbIDevCapRange aBitRates)

Public Attributes
readonly attribute ACString	type

readonly attribute nsIArray	supportedExplicitSizes

readonly attribute sbIDevCapRange	supportedWidths

readonly attribute sbIDevCapRange	supportedHeights

readonly attribute boolean	doesSupportPARRange

readonly attribute nsIArray	supportedPARs

readonly attribute sbIDevCapFraction	minimumSupportedPAR

readonly attribute sbIDevCapFraction	maximumSupportedPAR

readonly attribute boolean	doesSupportFrameRateRange

readonly attribute nsIArray	supportedFrameRates

readonly attribute sbIDevCapFraction	minimumSupportedFrameRate

readonly attribute sbIDevCapFraction	maximumSupportedFrameRate

readonly attribute sbIDevCapRange	supportedBitRates

Detailed Description

This interface describes the capabilities for the video streams

Definition at line 290 of file sbIDeviceCapabilities.idl.

Member Function Documentation

void sbIDevCapVideoStream::initialize	(	in ACString	aType,
		in nsIArray	aExplicitSizes,
		in sbIDevCapRange	aWidths,
		in sbIDevCapRange	aHeights,
		in nsIArray	aSupportedPARs,
		in boolean	aSupportedPARsIsRange,
		in nsIArray	aSupportedFrameRates,
		in boolean	aSupportedFrameRatesIsRange,
		in sbIDevCapRange	aBitRates
	)

Initializes the video stream capabilities

If supported PARs is a range, the array should have exactly two elements, the first of which is the minimum and the second is the maximum. Similarly, if the supported frame rates is a range, that array should have exactly two elements in the same order as well.

Member Data Documentation

readonly attribute boolean sbIDevCapVideoStream::doesSupportFrameRateRange

Returns true if the video stream supports ranges (i.e. min/max values) for the frame rates. If this attribute is true, use the |minimumSupportedFrameRate| and the |maximumSupportedFrameRate| attributes this interface for the frame rate range.

If this attribute returns false, a set list of frame rate values will be available via the |supportedFrameRates| attribute.

Definition at line 371 of file sbIDeviceCapabilities.idl.

readonly attribute boolean sbIDevCapVideoStream::doesSupportPARRange

Returns true if the video stream supports ranges (i.e. min/max values) for the PAR. If this attribute is true, use the |minimumSupportedPAR| and the |maximumSupportedPAR| attributes on this interface for the PAR range.

If this attribute returns false, a set list of PAR values will be available via the |supportedPARs| attribute.

Definition at line 346 of file sbIDeviceCapabilities.idl.

readonly attribute sbIDevCapFraction sbIDevCapVideoStream::maximumSupportedFrameRate

Definition at line 386 of file sbIDeviceCapabilities.idl.

readonly attribute sbIDevCapFraction sbIDevCapVideoStream::maximumSupportedPAR

Definition at line 360 of file sbIDeviceCapabilities.idl.

readonly attribute sbIDevCapFraction sbIDevCapVideoStream::minimumSupportedFrameRate

Returns the minimum and maximum frame rate values. If |doesSupportFrameRateRange| is false, these values will throw NS_ERROR_NOT_AVAILABLE.

Definition at line 385 of file sbIDeviceCapabilities.idl.

readonly attribute sbIDevCapFraction sbIDevCapVideoStream::minimumSupportedPAR

Returns the minimum and maximum PAR values. If |doesSupportPARRange| is false, these values will throw NS_ERROR_NOT_AVAILABLE.

Definition at line 359 of file sbIDeviceCapabilities.idl.

readonly attribute sbIDevCapRange sbIDevCapVideoStream::supportedBitRates

Returns a range of bit rates

Definition at line 391 of file sbIDeviceCapabilities.idl.

readonly attribute nsIArray sbIDevCapVideoStream::supportedExplicitSizes

Array of supported sizes. Each item in the array is an sbIImageSize giving an explicit width and height.

The array MUST NOT be empty; if arbitrary dimensions are supported then this array should contain a single 'recommended' size

Definition at line 322 of file sbIDeviceCapabilities.idl.

readonly attribute nsIArray sbIDevCapVideoStream::supportedFrameRates

Returns an array of the supported frame rate values as |sbIDevCapFraction| instances. When the attribute |doesSupportFrameRateRange| is false, use this array of frame rate values to get the supported frame rate values.

Definition at line 378 of file sbIDeviceCapabilities.idl.

readonly attribute sbIDevCapRange sbIDevCapVideoStream::supportedHeights

Range of supported heights.

May be null, in which case only the explicit sizes are permitted.

Definition at line 336 of file sbIDeviceCapabilities.idl.

readonly attribute nsIArray sbIDevCapVideoStream::supportedPARs

Returns an array of the supported PAR values as |sbIDevCapFraction| instances. When the attribute |doesSupportPARRange| is false, use this array of PAR values to get the supported PAR values.

Definition at line 353 of file sbIDeviceCapabilities.idl.

readonly attribute sbIDevCapRange sbIDevCapVideoStream::supportedWidths

Range of supported widths.

May be null, in which case only the explicit sizes are permitted.

Definition at line 329 of file sbIDeviceCapabilities.idl.

readonly attribute ACString sbIDevCapVideoStream::type

Container type

Definition at line 313 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