Windows Virtual Shields for Arduino
Public Member Functions | List of all members
Camera Class Reference

#include <Camera.h>

Inherits Sensor.

Public Member Functions

 Camera (const VirtualShield &shield)
 Initializes a new instance of the Camera class. More...
 
int enablePreview (bool enable)
 Enables the camera preview. More...
 
int capture (String url=(const char *) 0)
 Captures a picture and optionally saves/sends it to the specified URL. More...
 
void onJsonReceived (JsonObject &root, ShieldEvent *shieldEvent) override
 Event called when a valid json message was received. Consumes the proper values for this sensor. More...
 
- Public Member Functions inherited from Sensor
 Sensor (const VirtualShield &shield, const char sensorType)
 Initializes a new instance of the Sensor class. More...
 
int start (double delta=0, long interval=0)
 Starts the sensor, triggered when longer than the interval and larger than the delta. More...
 
virtual int stop ()
 Stops this sensor. More...
 
int get ()
 Gets a single, current sensor reading. More...
 
int getOnChange (double delta=0)
 Requests a single reading when more than the delta beyond the current reading. More...
 
bool isUpdated ()
 Determines whether this sensor has an updated value. Resets to false after this call. More...
 
int writeAll (const char *serviceName, EPtr values[], int count, Attr extraAttributes[]=0, int extraAttributeCount=0)
 Writes all EPtr values to the communication channel. More...
 
int sensorAction (SensorAction sensorAction, double delta=0, long interval=0) const
 Sends the specific action to start/stop/get/onChange the sensor using a delta and interval. More...
 
virtual bool isEvent (const char *tag, const char *action, ShieldEvent *shieldEvent)
 Determines whether the specified shieldEvent matches the tag and action. More...
 
virtual bool isEvent (int id, const char *action, ShieldEvent *shieldEvent)
 Determines whether the specified shieldEvent matches the id and action. More...
 
void setOnEvent (void(*onEvent)(ShieldEvent *shieldEvent))
 
int sendStop (const char *serviceName)
 

Additional Inherited Members

- Public Attributes inherited from Sensor
void(* onEvent )(ShieldEvent *shieldEvent)
 
VirtualShieldshield
 
ShieldEvent recentEvent
 
const char sensorType
 
bool isRunning = false
 
- Protected Attributes inherited from Sensor
bool _isUpdated = false
 

Constructor & Destructor Documentation

Camera::Camera ( const VirtualShield shield)

Initializes a new instance of the Camera class.

Parameters
shieldThe shield.

Member Function Documentation

int Camera::capture ( String  url = (const char*) 0)

Captures a picture and optionally saves/sends it to the specified URL.

Parameters
urlThe URL.
Returns
int.
int Camera::enablePreview ( bool  enable)

Enables the camera preview.

Parameters
enabletrue to enable, false to disable.
Returns
int.
void Camera::onJsonReceived ( JsonObject &  root,
ShieldEvent shieldEvent 
)
overridevirtual

Event called when a valid json message was received. Consumes the proper values for this sensor.

Parameters
rootThe root json object.
shieldEventThe shield event.

Reimplemented from Sensor.


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