buzz.getcoco.iot

Class NativeInterface

java.lang.Object

buzz.getcoco.iot.NativeInterface

public abstract class NativeInterface
extends java.lang.Object

This interface mimics signatures for api methods in Native.

Constructor Summary

Constructors

Constructor and Description
NativeInterface()

Method Summary

Modifier and Type	Method and Description
protected abstract void	captureSnapshot(Capability capability, java.lang.String downloadPath, int heightPx, int widthPx, long timeout, CapabilitySnapshot.SnapshotListener listener) A function to capture snapshot from the resource with CapabilitySnapshot provided custom aspect ratio, provided timeout and save the snapshot at provided download path.
protected abstract void	closeTunnel(Capability tunnel, long tunnelHandle, long timeout) A function to close a tunnel that was previously opened.
protected abstract void	connect(Network network, int port) A function to connect to a Network.
protected abstract void	connectWithInvite(Network network, java.lang.String inviteUrl, long nodeId) A function to connect to network using invite url.
protected abstract void	disconnect(Network network) A function to disconnect from Network.
protected abstract void	executeScene(Scene scene) A function to execute Scene.
protected abstract void	getAccessTokens(CocoClient.AccessTokensListener listener) A function to get access token.
protected abstract void	getAllNetworks(CocoClient.NetworkListListener listener) A function to get all network the user currently part of.
protected abstract int[]	getAvailableChannelPorts(Device device, int portCount) A Media streaming helper function to get free ports to talk to the device param.
protected abstract int[]	getHandlingChannelPorts(long streamHandle) A Media Streaming helper function to fetch channel ports from SDK.
protected abstract Resource	getHandlingResource(long streamHandle) A Media streaming helper function to get resource with MediaStreamingCapability from SDK.
protected abstract long	getHandlingStreamId(long streamHandle) A Media streaming helper function to get stream ID from SDK.
protected abstract int	getHandlingStreamSessionId(long streamHandle) A Media Streaming helper function to fetch stream session ID from SDK.
protected abstract Network[]	getSavedNetworks() A function to get saved networks.
protected abstract java.lang.String	getVersion() A function to get version info of Client SDK.
protected abstract void	informNetworkChange() A function to inform SDK that the networks is changed from 4G to Wi-Fi and vice versa.
protected abstract void	init(java.lang.String cwdPath, java.lang.String appAccessList, java.lang.String clientId, java.lang.String downloadPath, CocoClient.ConnectivityTimers timers) This function initializes the SDK.
protected abstract void	invalidateAccessToken() A function to invalidate the current accessToken.
protected abstract void	leaveNetwork(Network network, Network.LeaveStatusListener listener) A function to leave Network.
protected abstract void	openTunnel(Capability tunnel, java.lang.String forwardHostName, int forwardHostPort, java.lang.String listeningHostName, int listeningHostPort, CapabilityTunnel.IpVersion ipVersion, CapabilityTunnel.Protocol tunnelProtocol, CapabilityTunnel.TunnelType tunnelType, CapabilityTunnel.TransportType transportType, long timeout, CapabilityTunnel.TunnelStatusListener listener) A function to establish a tunnel connection that facilitates exchange of packets with a resource.
protected abstract void	sendContentInfo(Network network, long contentTime, java.lang.String data, long[] nodeIds) This function sends content info message to the destination nodes specified.
protected abstract void	sendData(Network network, java.lang.String data, long[] nodeIds) A function to send data to other nodes.
protected abstract void	sendDeviceManagementCommand(Device device, Command<Device.CommandId> command, Device.DeviceManagementStatusListener listener) A function to send device management commands.
protected abstract void	sendInfoRequest(InfoRequest infoRequest, Device.InfoRequestStatusListener listener) A function to send info request.
protected abstract void	sendInfoResponse(InfoResponse infoResponse, Device.InfoResponseStatusListener listener) A function to send info response to info request sent by Device.
protected abstract int	sendMediaStreamData(long streamHandle, int channelPort, long frameIndex, int frameType, long frameDuration, long framePts, java.nio.ByteBuffer data) This function sends stream data.
protected abstract void	sendNetworkManagementCommand(Network network, Command<Network.CommandId> command, Network.NetworkManagementStatusListener listener) A function to send network management command.Check Network.CommandId for network management commands.
protected abstract void	sendResourceCommand(Capability capability, Command<? extends Capability.CommandId> command, Capability.CommandStatusListener<?> listener) A function to execute command on a resource.
protected abstract void	setConnectivityMode(CocoClient.ConnectivityMode mode) A function to set CocoClient.ConnectivityMode.
protected abstract void	setTokens(java.lang.String response) A function to set tokens which will be used during HTTP calls.
protected abstract void	startMediaStream(Capability capability, long streamId, int streamSessionId, java.lang.String streamDescription, int[] channelPorts, CapabilityMediaStreaming.TransportType[] transportTypes, CapabilityMediaStreaming.MediaSessionType sessionType, long timeout, CapabilityMediaStreaming.MediaStreamListener listener) This function starts a media stream.
protected abstract void	stopMediaStream(long streamHandle) A function to stop the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeInterface

public NativeInterface()

Method Detail

init

protected abstract void init(java.lang.String cwdPath,
                             java.lang.String appAccessList,
                             java.lang.String clientId,
                             java.lang.String downloadPath,
                             CocoClient.ConnectivityTimers timers)

This function initializes the SDK.

Parameters:

cwdPath - Current working directory for storing config files.

appAccessList - The list of capabilities that the app will be using.

clientId - The client id generated for the developer.

downloadPath - Directory for temporary file storage.

timers - Useful to define SDK connectivity timers.

See Also:

CocoClient.ConnectivityTimers

getSavedNetworks

protected abstract Network[] getSavedNetworks()

A function to get saved networks.

Returns:

array of networks.

getAllNetworks

protected abstract void getAllNetworks(CocoClient.NetworkListListener listener)

A function to get all network the user currently part of.

Parameters:

listener - The listener that would be triggered with result.

connect

protected abstract void connect(Network network,
                                int port)

A function to connect to a Network.

Parameters:

network - Network to which user needs to connect.

port - Port over which connection should happen.

disconnect

protected abstract void disconnect(Network network)

A function to disconnect from Network.

Parameters:

network - network from which user needs to disconnect.

leaveNetwork

protected abstract void leaveNetwork(Network network,
                                     Network.LeaveStatusListener listener)

A function to leave Network.

Parameters:

network - Network from which user want to leave.

listener - Network.LeaveStatusListener which would be triggered with result.

sendInfoResponse

protected abstract void sendInfoResponse(InfoResponse infoResponse,
                                         Device.InfoResponseStatusListener listener)

A function to send info response to info request sent by Device.

Parameters:

infoResponse - InfoResponse

listener - Device.InfoResponseStatusListener that would be triggered with result.

sendResourceCommand

protected abstract void sendResourceCommand(Capability capability,
                                            Command<? extends Capability.CommandId> command,
                                            Capability.CommandStatusListener<?> listener)

A function to execute command on a resource.

Parameters:

capability - Capability on which command need to be executed.

command - Command of the Capability

listener - Capability.CommandStatusListener that would be triggered with result.

setTokens

protected abstract void setTokens(java.lang.String response)

A function to set tokens which will be used during HTTP calls.

Parameters:

response - tokens. //TODO: change argument name.

openTunnel

protected abstract void openTunnel(Capability tunnel,
                                   java.lang.String forwardHostName,
                                   int forwardHostPort,
                                   java.lang.String listeningHostName,
                                   int listeningHostPort,
                                   CapabilityTunnel.IpVersion ipVersion,
                                   CapabilityTunnel.Protocol tunnelProtocol,
                                   CapabilityTunnel.TunnelType tunnelType,
                                   CapabilityTunnel.TransportType transportType,
                                   long timeout,
                                   CapabilityTunnel.TunnelStatusListener listener)

A function to establish a tunnel connection that facilitates exchange of packets with a resource.

Parameters:

tunnel - CapabilityTunnel instance to be opened.

forwardHostName - The hostname which will receive the data.

forwardHostPort - The port over which the packets will be exchanged.

listeningHostName - The hostname of the transmitting device.

listeningHostPort - The port over which the device will transmit data.

ipVersion - The ipVersion used for identification (ipV4/ipV6).

tunnelProtocol - The protocol of the data exchange in tunnel, should be one of CapabilityTunnel.AttributeId.SUPPORTED_PROTOCOL_ARR (RTSP).

tunnelType - The type of the tunnel CapabilityTunnel.TunnelType (LISTEN/CONNECT).

transportType - The TransportType (TCP/UDP) on which the transmission shall take place.

timeout - The timeout for this command in millis.

listener - The listener which will be triggered after the callback. This will be useful in tracking in tunnelStatusCbs.

closeTunnel

protected abstract void closeTunnel(Capability tunnel,
                                    long tunnelHandle,
                                    long timeout)

A function to close a tunnel that was previously opened.

Parameters:

tunnel - CapabilityTunnel instance to be closed.

tunnelHandle - The handle responsible for tunneling.

timeout - The timeout for the command.

getAccessTokens

protected abstract void getAccessTokens(CocoClient.AccessTokensListener listener)

A function to get access token.

Parameters:

listener - CocoClient.AccessTokensListener that would be triggered with result.

sendNetworkManagementCommand

protected abstract void sendNetworkManagementCommand(Network network,
                                                     Command<Network.CommandId> command,
                                                     Network.NetworkManagementStatusListener listener)

A function to send network management command.Check Network.CommandId for network management commands.

Parameters:

network - Network on which command needs to be executed.

command - commands which needs to be sent.

listener - Network.NetworkManagementStatusListener that would be triggered

sendDeviceManagementCommand

protected abstract void sendDeviceManagementCommand(Device device,
                                                    Command<Device.CommandId> command,
                                                    Device.DeviceManagementStatusListener listener)

A function to send device management commands.

Parameters:

device - Device on which this command need to be executed.

command - Device.CommandId which needs to be sent.

listener - Device.DeviceManagementStatusListener trigger that would be triggered with result.

executeScene

protected abstract void executeScene(Scene scene)

A function to execute Scene.

Parameters:

scene - Scene which needs to be executed.

connectWithInvite

protected abstract void connectWithInvite(Network network,
                                          java.lang.String inviteUrl,
                                          long nodeId)

A function to connect to network using invite url.

Parameters:

network - Network to which user need to connect.

inviteUrl - The generated invite URL.

nodeId - Node ID of user to be invited.

sendInfoRequest

protected abstract void sendInfoRequest(InfoRequest infoRequest,
                                        Device.InfoRequestStatusListener listener)

A function to send info request.

Parameters:

infoRequest - Info request that should be sent.

listener - Device.InfoRequestStatusListener that would be triggered with result.

startMediaStream

protected abstract void startMediaStream(Capability capability,
                                         long streamId,
                                         int streamSessionId,
                                         java.lang.String streamDescription,
                                         int[] channelPorts,
                                         CapabilityMediaStreaming.TransportType[] transportTypes,
                                         CapabilityMediaStreaming.MediaSessionType sessionType,
                                         long timeout,
                                         CapabilityMediaStreaming.MediaStreamListener listener)

This function starts a media stream.

Parameters:

capability - CapabilityMediaStreaming.

streamId - ID of the stream.

streamSessionId - The interface over which the callbacks should be received.

streamDescription - The description (probably in SDP or other formats supported by the capability)

channelPorts - The Ports over which this communication should take place.

transportTypes - The transportTypes corresponding to the channels.

sessionType - The MediaSessionType of this stream.

timeout - The timeout for this command in millis.

listener - The listeners over which the callbacks will be propagated.

stopMediaStream

protected abstract void stopMediaStream(long streamHandle)

A function to stop the stream.

Parameters:

streamHandle - A non zero long value representing a native pointer.

captureSnapshot

protected abstract void captureSnapshot(Capability capability,
                                        java.lang.String downloadPath,
                                        int heightPx,
                                        int widthPx,
                                        long timeout,
                                        CapabilitySnapshot.SnapshotListener listener)

A function to capture snapshot from the resource with CapabilitySnapshot provided custom aspect ratio, provided timeout and save the snapshot at provided download path.

Parameters:

capability - CapabilitySnapshot instance of the resource.

downloadPath - The path to the file which has to be 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.

sendMediaStreamData

protected abstract int sendMediaStreamData(long streamHandle,
                                           int channelPort,
                                           long frameIndex,
                                           int frameType,
                                           long frameDuration,
                                           long framePts,
                                           java.nio.ByteBuffer data)

This function sends stream data.

Parameters:

streamHandle - A non zero long value representing a native pointer.

channelPort - The port over which this communication should take place.

frameIndex - Index which increments on every call.

frameType - Type of frame as in CapabilityMediaStreaming.FrameTypes.

frameDuration - Duration for each frame.

framePts - Presentation time stamp of when this frame is displayed.

data - A byte buffer comprising data.

Returns:

Queued number of bytes.

getAvailableChannelPorts

protected abstract int[] getAvailableChannelPorts(Device device,
                                                  int portCount)

A Media streaming helper function to get free ports to talk to the device param.

Parameters:

device - Device instance for which the request is made.

portCount - Required number of ports.

Returns:

An array of available channel ports.

getHandlingResource

protected abstract Resource getHandlingResource(long streamHandle)

A Media streaming helper function to get resource with MediaStreamingCapability from SDK.

Parameters:

streamHandle - A non zero long value representing a native pointer.

Returns:

The Resource as stored by stream handle.

getHandlingStreamId

protected abstract long getHandlingStreamId(long streamHandle)

A Media streaming helper function to get stream ID from SDK.

Parameters:

streamHandle - A non zero long value representing a native pointer.

Returns:

Stream ID as stored by stream handle.

getHandlingStreamSessionId

protected abstract int getHandlingStreamSessionId(long streamHandle)

A Media Streaming helper function to fetch stream session ID from SDK.

Parameters:

streamHandle - A non zero long value representing a native pointer.

Returns:

Stream session ID as stored by stream handle.

getHandlingChannelPorts

protected abstract int[] getHandlingChannelPorts(long streamHandle)

A Media Streaming helper function to fetch channel ports from SDK.

Parameters:

streamHandle - A non zero long value representing a native pointer.

Returns:

Channel handling ports as stored by stream handle.

setConnectivityMode

protected abstract void setConnectivityMode(CocoClient.ConnectivityMode mode)

A function to set CocoClient.ConnectivityMode.

Parameters:

mode - CocoClient.ConnectivityMode.

invalidateAccessToken

protected abstract void invalidateAccessToken()

A function to invalidate the current accessToken.

getVersion

protected abstract java.lang.String getVersion()

A function to get version info of Client SDK.

Returns:

version info as String.

informNetworkChange

protected abstract void informNetworkChange()

A function to inform SDK that the networks is changed from 4G to Wi-Fi and vice versa.

sendData

protected abstract void sendData(Network network,
                                 java.lang.String data,
                                 long[] nodeIds)

A function to send data to other nodes.

Parameters:

network - Network on which data needs to be sent.

data - Data that needs to be sent.

nodeIds - ID of nodes to which data needs to be sent.

sendContentInfo

protected abstract void sendContentInfo(Network network,
                                        long contentTime,
                                        java.lang.String data,
                                        long[] nodeIds)

This function sends content info message to the destination nodes specified.

Parameters:

network - The network in which the message has to be sent.

contentTime - The base time which will be used for tx delays.

data - The content of the message that has to be sent.

nodeIds - The destination nodes that will receive the message.