rec::robotino::com::JPGCamera Class Reference

Represents a camera. More...

#include <JPGCamera.h>

List of all members.

Public Member Functions

void setStreaming (bool streaming)
bool isStreaming () const
void setResolution (unsigned int width, unsigned int height)
void resolution (unsigned int *width, unsigned int *height) const
virtual void jpgReceivedEvent (const unsigned char *jpgData, unsigned int jpgDataSize)


Detailed Description

Represents a camera.

Member Function Documentation

void rec::robotino::com::JPGCamera::setStreaming ( bool  streaming  ) 

Turns the streaming on and off. Call this after connecting this object to a com object by calling setComId.

Parameters:
streaming TRUE to turn streaming on.
Exceptions:
RobotinoException If an error occured.

bool rec::robotino::com::JPGCamera::isStreaming (  )  const

Checks if streaming is enabled.

Returns:
TRUE if streaming is enabled.
Exceptions:
nothing. 

void rec::robotino::com::JPGCamera::setResolution ( unsigned int  width,
unsigned int  height 
)

Sets this camera to the given resolution (if possible)

Parameters:
width Requested image width
height Requested image height
Exceptions:
RobotinoException if given com object is invalid.

void rec::robotino::com::JPGCamera::resolution ( unsigned int *  width,
unsigned int *  height 
) const

Returns the width and height set by setResolution

Parameters:
width Set to the currently requested image width
height Set to the currently requested image height
Exceptions:
RobotinoException if given com object is invalid.

virtual void rec::robotino::com::JPGCamera::jpgReceivedEvent ( const unsigned char *  jpgData,
unsigned int  jpgDataSize 
) [virtual]

Called when an jpg or mjpeg image is received. Note: If Com is not initialized with useQueuedCallback=true this function is called from outside the applications main thread. This is extremely important particularly with regard to GUI applications.

Parameters:
jpgData Contains the jpeg data. You must not delete this buffer. Instead you should make a copy of this buffer within this function call.
jpgDataSize Is the size of the jpeg data buffer.
Exceptions:
nothing. 
See also:
Com::Com


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

Generated on Thu Dec 30 08:47:34 2010 for rec_robotino_com_c by  doxygen 1.5.5