PlayerCc::CameraProxy Class Reference

The CameraProxy class can be used to get images from a camera device. More...

#include <playerc++.h>

Inheritance diagram for PlayerCc::CameraProxy:
Inheritance graph
Collaboration diagram for PlayerCc::CameraProxy:
Collaboration graph

Detailed Description

The CameraProxy class can be used to get images from a camera device.

Public Member Functions

 CameraProxy (PlayerClient *aPc, uint32_t aIndex=0)
 Constructor.
 
virtual ~CameraProxy ()
 Destructor.
 
void SaveFrame (const std::string aPrefix, uint32_t aWidth=4)
 Save the frame. More...
 
void Decompress ()
 decompress the image
 
uint32_t GetDepth () const
 Image color depth.
 
uint32_t GetWidth () const
 Image dimensions (pixels)
 
uint32_t GetHeight () const
 Image dimensions (pixels)
 
uint32_t GetFormat () const
 Image format Possible values include. More...
 
uint32_t GetImageSize () const
 Size of the image (bytes)
 
void GetImage (uint8_t *aImage) const
 Image data This function copies the image data into the data buffer aImage. More...
 
uint32_t GetCompression () const
 What is the compression type? Currently supported compression types are: More...
 
- Public Member Functions inherited from PlayerCc::ClientProxy
bool IsValid () const
 Proxy has any information. More...
 
bool IsFresh () const
 Check for fresh data. More...
 
void NotFresh ()
 Reset Fresh flag. More...
 
std::string GetDriverName () const
 Get the underlying driver's name. More...
 
double GetDataTime () const
 Returns the received timestamp of the last data sample [s].
 
double GetElapsedTime () const
 Returns the time between the current data time and the time of the last data sample [s].
 
PlayerClientGetPlayerClient () const
 Get a pointer to the Player Client. More...
 
uint32_t GetIndex () const
 Get device index. More...
 
uint32_t GetInterface () const
 Get Interface Code. More...
 
std::string GetInterfaceStr () const
 Get Interface Name. More...
 
void SetReplaceRule (bool aReplace, int aType=-1, int aSubtype=-1)
 Set a replace rule for this proxy on the server. More...
 
int HasCapability (uint32_t aType, uint32_t aSubtype)
 Request capabilities of device. More...
 
int GetBoolProp (char *aProperty, bool *aValue)
 Request a boolean property. More...
 
int SetBoolProp (char *aProperty, bool aValue)
 Set a boolean property. More...
 
int GetIntProp (char *aProperty, int32_t *aValue)
 Request an integer property. More...
 
int SetIntProp (char *aProperty, int32_t aValue)
 Set an integer property. More...
 
int GetDblProp (char *aProperty, double *aValue)
 Request a double property. More...
 
int SetDblProp (char *aProperty, double aValue)
 Set a double property. More...
 
int GetStrProp (char *aProperty, char **aValue)
 Request a string property. More...
 
int SetStrProp (char *aProperty, char *aValue)
 Set a string property. More...
 
template<typename T >
connection_t ConnectReadSignal (T aSubscriber)
 Connect a read signal to this proxy. More...
 
void DisconnectReadSignal (connection_t aSubscriber)
 Disconnect a signal from this proxy. More...
 

Private Member Functions

virtual void Subscribe (uint32_t aIndex)
 
virtual void Unsubscribe ()
 

Private Attributes

playerc_camera_tmDevice
 
std::string mPrefix
 
int mFrameNo
 

Additional Inherited Members

- Public Types inherited from PlayerCc::ClientProxy
typedef int connection_t
 
typedef boost::mutex::scoped_lock scoped_lock_t
 
typedef int read_signal_t
 
- Protected Member Functions inherited from PlayerCc::ClientProxy
 ClientProxy (PlayerClient *aPc, uint32_t aIndex)
 
template<typename T >
GetVar (const T &aV) const
 
template<typename T >
void GetVarByRef (const T aBegin, const T aEnd, T aDest) const
 
- Protected Attributes inherited from PlayerCc::ClientProxy
PlayerClientmPc
 
playerc_client_tmClient
 
playerc_device_tmInfo
 
bool mFresh
 

Member Function Documentation

◆ GetCompression()

uint32_t PlayerCc::CameraProxy::GetCompression ( ) const
inline

What is the compression type? Currently supported compression types are:

References playerc_camera_t::compression.

◆ GetFormat()

uint32_t PlayerCc::CameraProxy::GetFormat ( ) const
inline

◆ GetImage()

void PlayerCc::CameraProxy::GetImage ( uint8_t *  aImage) const
inline

Image data This function copies the image data into the data buffer aImage.

The buffer should be allocated according to the width, height, and depth of the image. The size can be found by calling GetImageSize().

References playerc_camera_t::image, and playerc_camera_t::image_count.

◆ SaveFrame()

void PlayerCc::CameraProxy::SaveFrame ( const std::string  aPrefix,
uint32_t  aWidth = 4 
)

Save the frame.

  • aPrefix is the string prefix to name the image.
  • aWidth is the number of 0s to pad the image numbering with.

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