OWLIFT Library for Android: UvcOwliftFunc Class Reference
OWLIFT Library for Android  1.8.0.0
Top Page
List of all members | Classes | Public Member Functions
UvcOwliftFunc Class Reference
Inheritance diagram for UvcOwliftFunc:
UsbOwliftFunc

Classes

class  Buffer
 
interface  Callback
 
class  Format
 
enum  PayloadType
 
enum  UncompEncodingType
 

Public Member Functions

boolean isStreaming ()
 
void startStream (Format format, int txw, int txh, boolean decoding, Callback cb) throws OwliftException
 
void stopStream ()
 
UncompEncodingType getUncompEncodingType ()
 
int getVersion ()
 
void setPostRecFrame (int w, int h, int sdw)
 
DecodeType getDecodeType ()
 
void setDecodeType (DecodeType type)
 

Detailed Description

UVC Function class.

Member Function Documentation

◆ getDecodeType()

DecodeType getDecodeType ( )

Returns decode type.

Returns
DecodeType

◆ getUncompEncodingType()

UncompEncodingType getUncompEncodingType ( )

Gets the encoding format of uncompressed payload.

It doesn't fix until calling startStream().

Returns
encoding format of uncompressed payload.

◆ getVersion()

int getVersion ( )

Returns UVC version of device.

Returns
UVC version.

◆ isStreaming()

boolean isStreaming ( )

Tests if this object is streaming.

Returns
true : Streaming. false : Otherwise.

◆ setDecodeType()

void setDecodeType ( DecodeType  type)

Sets decode type.

Parameters
typedecode type.
See also
DecodeType

◆ setPostRecFrame()

void setPostRecFrame ( int  w,
int  h,
int  sdw 
)

You can set frame size to record after call Callback.recvBuffer() function.
OwliftMediaRecorder.setVideoPostRecvBuffer()
You must set w, h lower than txw, txh that be set startStream().
You can record picture that change at Callback.recvBuffer().

Parameters
wwidth.
hheight.
sdwstride.

◆ startStream()

void startStream ( Format  format,
int  txw,
int  txh,
boolean  decoding,
Callback  cb 
) throws OwliftException

Starts streaming.

Parameters
formatImage format.
txwwidth of receiving buffer. It requires greater than or equal the value of Format.getWidth().
txhheight of receiving buffer. It requires greater than or equal the value of Format.getHeight().
decodingIf sets true, frame data is decoding to RGB565 format. If sets false, frame data is raw data from USB device. and ignored txw and txh.
In addition, can't use OwliftMediaRecorder The raw data from USB device has a possibility to get unusual data due to missing packet and/or USB transaction error. In that case, please consider it can't decode normally(may get Error) in any other library and/or applications.
cbCallback.
Exceptions
OwliftException

◆ stopStream()

void stopStream ( )

Stops streaming.