buzz.getcoco.iot

Class CapabilityMediaStreaming

java.lang.Object

buzz.getcoco.iot.Capability

buzz.getcoco.iot.CapabilityMediaStreaming

All Implemented Interfaces:

java.lang.Iterable<Attribute>

public class CapabilityMediaStreaming
extends Capability

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapabilityMediaStreaming.AttributeId enum denoting various possible attributes of the CapabilityMediaStreaming.
static class	CapabilityMediaStreaming.CommandId enum denoting the possible Commands that can be sent for CapabilityMediaStreaming.
static class	CapabilityMediaStreaming.ConfigRecording This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending configure recording commands.
static class	CapabilityMediaStreaming.DefaultMediaStreamListenerMultiplexer This class has the ability to multiplex the calls over individual channels.
static class	CapabilityMediaStreaming.FrameTypes possible values of frame types for the media streaming capability.
static class	CapabilityMediaStreaming.MediaSessionType possible values of media session type for the media streaming capability.
static interface	CapabilityMediaStreaming.MediaStreamListener Listener that receives updates from callbacks.
static interface	CapabilityMediaStreaming.MediaStreamListenerMultiplexer This interface has the relevant signatures to multiplex the calls over individual channels.
static class	CapabilityMediaStreaming.RecordMode possible values of record mode for the media streaming capability.
static class	CapabilityMediaStreaming.StartRecording This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending start recording commands.
static class	CapabilityMediaStreaming.Status possible values of media stream status for the media streaming capability.
static class	CapabilityMediaStreaming.StopRecording This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending stop recording commands.
static class	CapabilityMediaStreaming.TransportType possible values of media transport type for the media streaming capability.

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	CapabilityMediaStreaming(int id, Resource parent) Constructor of the current class.

Method Summary

Modifier and Type	Method and Description
protected Command<? extends Capability.CommandId>	extendedCreateCommand(int primitiveCommandId, com.google.gson.JsonElement commandParams) A function to create the command from the Json params.
int[]	getAvailableChannelPorts(int portCount)
static Capability	getHandlingCapability(long streamHandle) This function fetches the capability that is using provided stream handle.
static int[]	getHandlingChannelPorts(long streamHandle)
static long	getHandlingStreamId(long streamHandle)
static int	getHandlingStreamSessionId(long streamHandle)
protected <T extends Capability.CommandId> void	interceptCommand(Command<T> command)
int	sendData(long streamHandle, int channelPort, long frameIndex, int frameType, long frameDuration, long framePts, byte[] data, int offset, int size) This function sends data for communication.
int	sendData(long streamHandle, int channelPort, long frameIndex, int frameType, long frameDuration, long framePts, java.nio.ByteBuffer data) This function sends data for communication.
int[]	startStream(long streamId, int streamSessionId, java.lang.String streamDescription, CapabilityMediaStreaming.TransportType[] transportTypes, CapabilityMediaStreaming.MediaSessionType sessionType, long timeout, CapabilityMediaStreaming.MediaStreamListener listener) A function to start streaming using this capability.
void	startStream(long streamId, int streamSessionId, java.lang.String streamDescription, int[] channelPorts, CapabilityMediaStreaming.TransportType[] transportTypes, CapabilityMediaStreaming.MediaSessionType sessionType, long timeout, CapabilityMediaStreaming.MediaStreamListener listener) A function to start streaming using this capability.
void	stopStream(long streamHandle)
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, 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

CapabilityMediaStreaming

protected CapabilityMediaStreaming(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.

getHandlingCapability

public static Capability getHandlingCapability(long streamHandle)

This function fetches the capability that is using provided stream handle.

Parameters:

streamHandle - a non zero long value representing a native pointer

Returns:

Capability retrieved from capability map.

See Also:

Resource.getCapability(buzz.getcoco.iot.Capability.CapabilityId)

getHandlingStreamId

public static long getHandlingStreamId(long streamHandle)

getHandlingStreamSessionId

public static int getHandlingStreamSessionId(long streamHandle)

getHandlingChannelPorts

public static int[] getHandlingChannelPorts(long streamHandle)

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

getAvailableChannelPorts

public int[] getAvailableChannelPorts(int portCount)

startStream

public int[] startStream(long streamId,
                         int streamSessionId,
                         java.lang.String streamDescription,
                         CapabilityMediaStreaming.TransportType[] transportTypes,
                         CapabilityMediaStreaming.MediaSessionType sessionType,
                         long timeout,
                         CapabilityMediaStreaming.MediaStreamListener listener)

A function to start streaming using this capability.

Parameters:

streamId - The ID over which this communication should take place

streamSessionId - The sessionId which you would like to provide

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

transportTypes - The transportTypes corresponding to the channels

sessionType - An enum denoting session is live/buffered

timeout - The timeout for this command in millis

listener - The interface over which the callbacks should be received

Returns:

An array of free ports available for communication.

startStream

public void startStream(long streamId,
                        int streamSessionId,
                        java.lang.String streamDescription,
                        int[] channelPorts,
                        CapabilityMediaStreaming.TransportType[] transportTypes,
                        CapabilityMediaStreaming.MediaSessionType sessionType,
                        long timeout,
                        CapabilityMediaStreaming.MediaStreamListener listener)

A function to start streaming using this capability.

Parameters:

streamId - The ID over which this communication should take place

streamSessionId - The sessionId which you would like to provide

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

listener - The interface over which the callbacks should be received

timeout - The timeout for this command in millis NOTE: For multiplexing ability over individualChannels see: CapabilityMediaStreaming.MediaStreamListenerMultiplexer and CapabilityMediaStreaming.DefaultMediaStreamListenerMultiplexer

sendData

public int sendData(long streamHandle,
                    int channelPort,
                    long frameIndex,
                    int frameType,
                    long frameDuration,
                    long framePts,
                    byte[] data,
                    int offset,
                    int size)

This function sends data for communication.

Parameters:

streamHandle - a non zero long value representing a native pointer

channelPort - The Port over which this communication should take place

frameIndex - index of

frameType - frame type as present in CapabilityMediaStreaming.FrameTypes

frameDuration - duration for each frame

framePts - presentation time stamp field

data - byte array of data to be sent

offset - offset to included for communication delay

size - size of the frame data

Returns:

queued number of bytes

sendData

public int sendData(long streamHandle,
                    int channelPort,
                    long frameIndex,
                    int frameType,
                    long frameDuration,
                    long framePts,
                    java.nio.ByteBuffer data)

This function sends data for communication. NOTE: reads between 0 and limit on the buffer synchronization is needed coz, a single buffer is maintained in c-layer for all the send commands

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 - frame type as present in CapabilityMediaStreaming.FrameTypes

frameDuration - duration for each frame

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

data - byte buffer comprising data and offset

Returns:

queued number of bytes

stopStream

public void stopStream(long streamHandle)

interceptCommand

protected <T extends Capability.CommandId> void interceptCommand(Command<T> command)

Overrides:

interceptCommand in class Capability