com.mixer.interactive.protocol

Enum InteractiveMethod

java.lang.Object

java.lang.Enum<InteractiveMethod>

com.mixer.interactive.protocol.InteractiveMethod

All Implemented Interfaces:

Serializable, Comparable<InteractiveMethod>

public enum InteractiveMethod
extends Enum<InteractiveMethod>

Enum containing all the methods supported by the Interactive service.

Since:

1.0.0

Author:

Microsoft Corporation

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAPTURE
CREATE_CONTROLS
CREATE_GROUPS
CREATE_SCENES
DELETE_CONTROLS
DELETE_GROUP
DELETE_SCENE
GET_ACTIVE_PARTICIPANTS
GET_ALL_PARTICIPANTS
GET_GROUPS
GET_MEMORY_STATS
GET_SCENES
GET_THROTTLE_STATE
GET_TIME
GIVE_INPUT
HELLO
ISSUE_MEMORY_WARNING
ON_CONTROL_CREATE
ON_CONTROL_DELETE
ON_CONTROL_UPDATE
ON_GROUP_CREATE
ON_GROUP_DELETE
ON_GROUP_UPDATE
ON_PARTICIPANT_JOIN
ON_PARTICIPANT_LEAVE
ON_PARTICIPANT_UPDATE
ON_READY
ON_SCENE_CREATE
ON_SCENE_DELETE
ON_SCENE_UPDATE
READY
SET_BANDWIDTH_THROTTLE
SET_COMPRESSION
UNKNOWN
UPDATE_CONTROLS
UPDATE_GROUPS
UPDATE_PARTICIPANTS
UPDATE_SCENES

Method Summary

Modifier and Type	Method and Description
static InteractiveMethod	from(String methodName) Returns the associated InteractiveMethod object for the provided method name (if there is one).
String	toString() Returns a String representation of this InteractiveMethod.
static InteractiveMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static InteractiveMethod[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CAPTURE

public static final InteractiveMethod CAPTURE

CREATE_CONTROLS

public static final InteractiveMethod CREATE_CONTROLS

CREATE_GROUPS

public static final InteractiveMethod CREATE_GROUPS

CREATE_SCENES

public static final InteractiveMethod CREATE_SCENES

DELETE_CONTROLS

public static final InteractiveMethod DELETE_CONTROLS

DELETE_GROUP

public static final InteractiveMethod DELETE_GROUP

DELETE_SCENE

public static final InteractiveMethod DELETE_SCENE

GET_ACTIVE_PARTICIPANTS

public static final InteractiveMethod GET_ACTIVE_PARTICIPANTS

GET_ALL_PARTICIPANTS

public static final InteractiveMethod GET_ALL_PARTICIPANTS

GET_GROUPS

public static final InteractiveMethod GET_GROUPS

GET_MEMORY_STATS

public static final InteractiveMethod GET_MEMORY_STATS

GET_SCENES

public static final InteractiveMethod GET_SCENES

GET_THROTTLE_STATE

public static final InteractiveMethod GET_THROTTLE_STATE

GET_TIME

public static final InteractiveMethod GET_TIME

GIVE_INPUT

public static final InteractiveMethod GIVE_INPUT

HELLO

public static final InteractiveMethod HELLO

ISSUE_MEMORY_WARNING

public static final InteractiveMethod ISSUE_MEMORY_WARNING

ON_CONTROL_CREATE

public static final InteractiveMethod ON_CONTROL_CREATE

ON_CONTROL_DELETE

public static final InteractiveMethod ON_CONTROL_DELETE

ON_CONTROL_UPDATE

public static final InteractiveMethod ON_CONTROL_UPDATE

ON_GROUP_CREATE

public static final InteractiveMethod ON_GROUP_CREATE

ON_GROUP_DELETE

public static final InteractiveMethod ON_GROUP_DELETE

ON_GROUP_UPDATE

public static final InteractiveMethod ON_GROUP_UPDATE

ON_PARTICIPANT_JOIN

public static final InteractiveMethod ON_PARTICIPANT_JOIN

ON_PARTICIPANT_LEAVE

public static final InteractiveMethod ON_PARTICIPANT_LEAVE

ON_PARTICIPANT_UPDATE

public static final InteractiveMethod ON_PARTICIPANT_UPDATE

ON_READY

public static final InteractiveMethod ON_READY

ON_SCENE_CREATE

public static final InteractiveMethod ON_SCENE_CREATE

ON_SCENE_DELETE

public static final InteractiveMethod ON_SCENE_DELETE

ON_SCENE_UPDATE

public static final InteractiveMethod ON_SCENE_UPDATE

READY

public static final InteractiveMethod READY

SET_BANDWIDTH_THROTTLE

public static final InteractiveMethod SET_BANDWIDTH_THROTTLE

SET_COMPRESSION

public static final InteractiveMethod SET_COMPRESSION

UPDATE_CONTROLS

public static final InteractiveMethod UPDATE_CONTROLS

UPDATE_GROUPS

public static final InteractiveMethod UPDATE_GROUPS

UPDATE_PARTICIPANTS

public static final InteractiveMethod UPDATE_PARTICIPANTS

UPDATE_SCENES

public static final InteractiveMethod UPDATE_SCENES

UNKNOWN

public static final InteractiveMethod UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static InteractiveMethod valueOf(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:

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

NullPointerException - if the argument is null

from

public static InteractiveMethod from(String methodName)

Returns the associated InteractiveMethod object for the provided method name (if there is one).

Parameters:

methodName - Interactive method name

Returns:

The matching InteractiveMethod for the provided scheme name. If a match is not found then null is returned

Since:

1.0.0

toString

public String toString()

Returns a String representation of this InteractiveMethod.

Overrides:

toString in class Enum<InteractiveMethod>

Returns:

String representation of this InteractiveMethod

Since:

1.0.0