com.wowza.gocoder.sdk.api.data

Enum WOWZDataScope

java.lang.Object

java.lang.Enum<WOWZDataScope>

com.wowza.gocoder.sdk.api.data.WOWZDataScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WOWZDataScope>

public enum WOWZDataScope
extends java.lang.Enum<WOWZDataScope>

Identifiers for the various data scopes to which a data event can be targeted.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MODULE Data events sent with a MODULE scope will be mapped to an invocation of a public handler method contained within any active server module class having the same name as the event.
STREAM Data events sent with a STREAM scope will be delivered to each client subscribed to the stream.

Method Summary

Modifier and Type	Method and Description
int	getValue() Gets a unique integer-based value for each scope type.
static WOWZDataScope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WOWZDataScope[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STREAM

public static final WOWZDataScope STREAM

Data events sent with a STREAM scope will be delivered to each client subscribed to the stream.

MODULE

public static final WOWZDataScope MODULE

Data events sent with a MODULE scope will be mapped to an invocation of a public handler method contained within any active server module class having the same name as the event.

Method Detail

values

public static WOWZDataScope[] 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 (WOWZDataScope c : WOWZDataScope.values())
    System.out.println(c);

Returns:

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

valueOf

public static WOWZDataScope 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

getValue

public int getValue()

Gets a unique integer-based value for each scope type.

Returns:

A unique integer representation.