buzz.getcoco.iot

Class CapabilitySnapshot

java.lang.Object

buzz.getcoco.iot.Capability

buzz.getcoco.iot.CapabilitySnapshot

All Implemented Interfaces:

java.lang.Iterable<Attribute>

public class CapabilitySnapshot
extends Capability

This class describes Commands and Attributes for Snapshot Capability of a Resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapabilitySnapshot.AttributeId enum denoting various possible attributes of the CapabilitySnapshot.
static class	CapabilitySnapshot.CommandId enum denoting the possible Commands that can be sent for CapabilitySnapshot.
static class	CapabilitySnapshot.GrabImage This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending Grab Image commands.
static interface	CapabilitySnapshot.SnapshotListener Listener provides callback to listen for snapshot events.
static class	CapabilitySnapshot.SnapshotStatus possible values for status of snapshot.

Nested classes/interfaces inherited from class buzz.getcoco.iot.Capability

Capability.CapabilityId, Capability.CommandStatusListener<T extends Capability.CommandId>

Field Summary

Fields

Modifier and Type	Field and Description
static Capability.CapabilityId	ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CapabilitySnapshot(int id, Resource parent) Constructor of the current class.

Method Summary

Modifier and Type	Method and Description
void	captureSnapshot(java.lang.String downloadPath, int heightPx, int widthPx, long timeout, CapabilitySnapshot.SnapshotListener listener) A function to capture snapshot from the resource.
protected Command<? extends Capability.CommandId>	extendedCreateCommand(int primitiveCommandId, com.google.gson.JsonElement commandParams) A function to create the command from the Json params.
boolean	supports(Capability.CommandId commandId) This function checks if a command is supported or not, pass null to check if capability supports any commands at all.

Methods inherited from class buzz.getcoco.iot.Capability

clearAndSetStandardCommandSet, containsAttribute, containsAttribute, createCommand, createCommandResponseArgs, getAttribute, getAttribute, getAttributeMap, getCapabilityWrapper, getId, getName, getParent, getSupportedCommands, hashCode, interceptCommand, internalAddAttribute, internalMarkAsReady, internalRemoveAttribute, internalSetName, internalSetParent, isReady, iterator, sendResourceCommand, setCapabilityWrapper, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

ID

public static final Capability.CapabilityId ID

Constructor Detail

CapabilitySnapshot

protected CapabilitySnapshot(int id,
                             Resource parent)

Constructor of the current class.

Parameters:

id - The unique id Of the capability

parent - The parent Resource of the capability.

Method Detail

supports

public boolean supports(Capability.CommandId commandId)

Description copied from class: Capability

This function checks if a command is supported or not, pass null to check if capability supports any commands at all. NOTE: Check the overridden function also for a complete view.

Overrides:

supports in class Capability

Parameters:

commandId - The Id denoting the command to be sent.

Returns:

boolean: If the command is supported then True is returned.

extendedCreateCommand

protected Command<? extends Capability.CommandId> extendedCreateCommand(int primitiveCommandId,
                                                                        com.google.gson.JsonElement commandParams)

Description copied from class: Capability

A function to create the command from the Json params. NOTE: This must be only used by classes extending this class.

Specified by:

extendedCreateCommand in class Capability

Parameters:

primitiveCommandId - The int form of the commandId

commandParams - The Json params that can form a command

Returns:

The command which is formed

captureSnapshot

public void captureSnapshot(java.lang.String downloadPath,
                            int heightPx,
                            int widthPx,
                            long timeout,
                            CapabilitySnapshot.SnapshotListener listener)

A function to capture snapshot from the resource.

Parameters:

downloadPath - The path to the file which has to downloaded. NOTE: This should be the absolute path

heightPx - The height of the image which has to be downloaded

widthPx - The width of the image which has to be downloaded

timeout - The timeout for this command

listener - The listener which will be triggered after the callback