buzz.getcoco.iot

Enum CapabilityMediaStreaming.AttributeId

java.lang.Object

java.lang.Enum<CapabilityMediaStreaming.AttributeId>

buzz.getcoco.iot.CapabilityMediaStreaming.AttributeId

All Implemented Interfaces:

Capability.AttributeId, CommandIdInterface, java.io.Serializable, java.lang.Comparable<CapabilityMediaStreaming.AttributeId>

Enclosing class:

CapabilityMediaStreaming

public static enum CapabilityMediaStreaming.AttributeId
extends java.lang.Enum<CapabilityMediaStreaming.AttributeId>
implements Capability.AttributeId

enum denoting various possible attributes of the CapabilityMediaStreaming.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE_CLIENTS_ARR Determines the number of clients which are consuming the stream at the moment.
CONTENT_RECEIVE_BUFFER_SIZE_ARR Determines receive buffer sizes when streaming.
CONTENT_SEND_BUFFER_SIZE_ARR Determines send buffer sizes when streaming.
DESCRIPTOR Determines the SDP value of the stream from this streaming resource.
ID_ARR Determines the stream IDs that can be streamed from this capability.
MAX_ACTIVE_CLIENTS_ARR Determines the maximum number of clients that can consume the stream at any moment.
REC_STATUS_ARR Determines if a stream is being recorded or not.
REC_SUPPORTED_ARR Determines if recording a stream is possible or not.
RECORDING_IN_PROGRESS Determines the time since when the recording has started.

Method Summary

Modifier and Type	Method and Description
Capability.CapabilityId	getCapabilityId() A function to get Capability.CapabilityId of parent capability.
static CapabilityMediaStreaming.AttributeId	getEnum(int index) A function to get Capability.AttributeId.
int	getInt() A function to get ordinal value of enum.
static CapabilityMediaStreaming.AttributeId	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CapabilityMediaStreaming.AttributeId[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DESCRIPTOR

public static final CapabilityMediaStreaming.AttributeId DESCRIPTOR

Determines the SDP value of the stream from this streaming resource.

ID_ARR

public static final CapabilityMediaStreaming.AttributeId ID_ARR

Determines the stream IDs that can be streamed from this capability.

 array of streamingIds eg: {0, 1, 2}
           ----------------|   |  |-------------
           |                   |               |
        video in           audio in         audio out
 

ACTIVE_CLIENTS_ARR

public static final CapabilityMediaStreaming.AttributeId ACTIVE_CLIENTS_ARR

Determines the number of clients which are consuming the stream at the moment. array of active clients count per stream eg: {1, 1, 0}

MAX_ACTIVE_CLIENTS_ARR

public static final CapabilityMediaStreaming.AttributeId MAX_ACTIVE_CLIENTS_ARR

Determines the maximum number of clients that can consume the stream at any moment. array of max clients count per stream eg:{2, 2, 2}

REC_STATUS_ARR

public static final CapabilityMediaStreaming.AttributeId REC_STATUS_ARR

Determines if a stream is being recorded or not. array of streamIds recording status eg: {true, false, false} true indicates recording in-progress

REC_SUPPORTED_ARR

public static final CapabilityMediaStreaming.AttributeId REC_SUPPORTED_ARR

Determines if recording a stream is possible or not. boolean array mapped to streamIds indicates the whether a stream supports recording eg: {true, false, false} true indicates streamId supports recording

RECORDING_IN_PROGRESS

public static final CapabilityMediaStreaming.AttributeId RECORDING_IN_PROGRESS

Determines the time since when the recording has started. array of timers one-to-one mapped to streamIds in ID_ARR

CONTENT_SEND_BUFFER_SIZE_ARR

public static final CapabilityMediaStreaming.AttributeId CONTENT_SEND_BUFFER_SIZE_ARR

Determines send buffer sizes when streaming. array of send buffer sizes mapped to streamIds in ID_ARR

CONTENT_RECEIVE_BUFFER_SIZE_ARR

public static final CapabilityMediaStreaming.AttributeId CONTENT_RECEIVE_BUFFER_SIZE_ARR

Determines receive buffer sizes when streaming. array of send buffer sizes mapped to streamIds in ID_ARR

Method Detail

values

public static CapabilityMediaStreaming.AttributeId[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CapabilityMediaStreaming.AttributeId c : CapabilityMediaStreaming.AttributeId.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CapabilityMediaStreaming.AttributeId valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getEnum

public static CapabilityMediaStreaming.AttributeId getEnum(int index)

A function to get Capability.AttributeId.

Parameters:

index - index of the required Capability.AttributeId.

Returns:

Capability.AttributeId at the given index.

getInt

public int getInt()

A function to get ordinal value of enum.

Specified by:

getInt in interface CommandIdInterface

Returns:

ordinal of enum.

getCapabilityId

public Capability.CapabilityId getCapabilityId()

A function to get Capability.CapabilityId of parent capability.

Specified by:

getCapabilityId in interface Capability.AttributeId

Returns:

Capability.CapabilityId of parent.