UvcOwliftFunc.Format Class Reference

Public Member Functions
	Format (PayloadType payloadType, int width, int height, int interval)
	Format (PayloadType payloadType, UncompEncodingType ue, int width, int height, int interval)
PayloadType	getPayloadType ()
UncompEncodingType	getUncompEncodingType ()
int	getWidth ()
int	getHeight ()
int	getInterval ()
boolean	equals (Object o)

Detailed Description

A class for image format.

Constructor & Destructor Documentation

Format() [1/2]

Format	(	PayloadType	payloadType,
		int	width,
		int	height,
		int	interval
	)

The constructor.

Parameters

payloadType	UVC payload type.
width	width.
height	height.
interval	frame interval(unit: 100ns).

Format() [2/2]

Format	(	PayloadType	payloadType,
		UncompEncodingType	ue,
		int	width,
		int	height,
		int	interval
	)

The constructor.

Parameters

payloadType	UVC payload type.
ue	Encoding type of uncompressed payload.
width	width.
height	height.
interval	frame interval(unit: 100ns).

Member Function Documentation

equals()

boolean equals

(

Object

o

)

Compares all of elements between this object and 'o' object(argument).

Returns

true : completely matched. false : otherwise.

getHeight()

int getHeight

(

)

Returns height of resolution.

Returns

height.

getInterval()

int getInterval

(

)

Returns frame interval(100 ns unit).

Returns

frame interval(100 ns unit).

getPayloadType()

PayloadType getPayloadType

(

)

Returns UVC payload type.

Returns

UVC payload type.

getUncompEncodingType()

UncompEncodingType getUncompEncodingType

(

)

Returns encoding type of uncompressed payload.

This type will automatically select if specified UncompEncodingType.UNKNOWN with ) startStream().

Returns

encoding type of uncompressed payload.

getWidth()

int getWidth

(

)

Returns width of resolution.

Returns

width.