buzz.getcoco.iot

Class CapabilityStorageControl

java.lang.Object

buzz.getcoco.iot.Capability

buzz.getcoco.iot.CapabilityStorageControl

All Implemented Interfaces:

java.lang.Iterable<Attribute>

public class CapabilityStorageControl
extends Capability

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapabilityStorageControl.AttributeId enum denoting various possible attributes of the CapabilityStorageControl.
static class	CapabilityStorageControl.CommandId enum denoting the possible Commands that can be sent for CapabilityStorageControl.
static class	CapabilityStorageControl.Download This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending download commands.
static interface	CapabilityStorageControl.DownloadSegmentListener Listener provides callback to listen for download segment events.
static class	CapabilityStorageControl.GetMetadata This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending get_metadata commands.
static class	CapabilityStorageControl.GetVideoMetadataResponse Class useful in binding json response to object.
static class	CapabilityStorageControl.MimeType Possible values for mime types of each frame.
static class	CapabilityStorageControl.PlaybackError An enum denoting possible values for playback errors.
static class	CapabilityStorageControl.SegmentDownloadStatus Possible values for status of segment download.
static class	CapabilityStorageControl.StreamProtocol possible values for stream protocols.
static class	CapabilityStorageControl.Upload This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending upload commands.

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 ID for CapabilityStorageControl.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected <T extends CommandIdInterface> CommandResponse.Args<T>	createCommandResponseArgs(T commandId, com.google.gson.JsonElement jsonResponse) create response for the command.
void	downloadSegments(long contentId, java.lang.String sdp, long[] segmentIds, long timeout, CapabilityStorageControl.DownloadSegmentListener listener) A function to downloadSegments from the resource, provided timeout and save the segments at provided download path.
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 is used to check if a command is supported by the capability or not.

Methods inherited from class buzz.getcoco.iot.Capability

clearAndSetStandardCommandSet, containsAttribute, containsAttribute, createCommand, 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

ID for CapabilityStorageControl.

Constructor Detail

CapabilityStorageControl

protected CapabilityStorageControl(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)

This function is used to check if a command is supported by the capability or not.

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)

A function to create the command from the Json params.

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

createCommandResponseArgs

protected <T extends CommandIdInterface> CommandResponse.Args<T> createCommandResponseArgs(T commandId,
                                                                                           com.google.gson.JsonElement jsonResponse)

create response for the command.

Overrides:

createCommandResponseArgs in class Capability

Type Parameters:

T - Capture for casting.

Parameters:

commandId - The command ID which has to be responded

jsonResponse - The response body

Returns:

The created response

See Also:

CommandResponse.Args

downloadSegments

public void downloadSegments(long contentId,
                             java.lang.String sdp,
                             long[] segmentIds,
                             long timeout,
                             CapabilityStorageControl.DownloadSegmentListener listener)

A function to downloadSegments from the resource, provided timeout and save the segments at provided download path.

Parameters:

contentId - ID of the content.

sdp - Format supported by the capability.

segmentIds - SegmentIds to be downloaded.

timeout - Timeout for this command.

listener - The listener which will be triggered after the callback.