com.avaya.conferencing.api.acp.control
Enum States

java.lang.Object
  java.lang.Enum<States>
      com.avaya.conferencing.api.acp.control.States

All Implemented Interfaces:

State, java.io.Serializable, java.lang.Comparable<States>

public enum States
extends java.lang.Enum<States>
implements State

States published by the API.

Since:

5.1.0.0.29

Enum Constant Summary

ACCESSED
The accessed state.

AUTHENTICATING
The state related to an EndPoint that has not completed authentication and therefore we don't know if they are a MODERATOR or a conferee.

AUTOMATIC_GAIN_CONTROL_MODE
When gain is controlled automatically.

AVAILABLE_FOR_PLAYBACK
This state indicates that the record playback server is available for playback.

AVAILABLE_FOR_RECORDING
This state indicates that the record playback server is available for recording.

CONFERENCING_PROVIDER_LINK
The EndPoint is one end of a link to a second ConferencingProvider and can be used to share the media of two Conference

DETAILS_PROTECTED
The conference details are protected from modification.

ENFORCE_PARTICIPANT_LIMITS
Tells a Conference that it MUST enforce the limits to the number of participants to that Conference.

ENTERING_DTMF
When an EndPoint is inputting DTMF.

ESTABLISHING
When an call to an EndPoint is being established.

FAULTED
The ConferencingObject has been marked as requiring maintenance.

HELD
The held state.

IDENTIFIED_PARTICIPANT_MODE
This state indicates that the conference requires all particpants to enter their unique participant identifier.

LECTURE_MODE
The conference lecture mode state.

MEASURING_DTMF_SIGNAL_TO_NOISE_RATIO
This state indicates whether any DTMFEvents for an EndPoint will include the signal-to-noise ratio of the DTMF tones.

MEASURING_SIGNAL_TO_NOISE_RATIO
This state indicates when the signal-to-noise ration of an EndPoint is being measured.

MESSAGE_PLAYBACK
When an EndPoint or a Conference is being played a message...

MODERATOR
The moderator state.

MODERATOR_DISCONNECT_MODE
The conference will be disconnected when the last moderator disconnects.

MUTED
The muted state.

OBSERVE_ONLY
The observe only state.

OBSERVED
The observed state.

OPERATOR
The operator state.

PASSTHROUGH_DTMF
Tells a Conference with audio media that it should not clamp DTMF received from each EndPoint but should instead pass any DTMF digits through to the conference.

PAUSED
The paused state.

PLAYBACK_MODE
The playing state.

POLLING_MODE
The polling state.

QA_HAS_QUESTION
The question state.

QA_MODE
The question and answer session state.

RECORD_PARTICIPANT_NAMES
The conference will attempt to record participant names when they initially join the conference.

RECORDING_MODE
The recording state.

REGENERATE_DTMF
This state indicates the re-synthesis of any DTMF tones that have been clamped (i.e.

SECURED_IDENTIFIED_PARTICIPANT_MODE
This state indicates that the conference requires all particpants to enter their unique participant identifier and secret PIN.

SECURED_MODE
The conference secured state.

SECURITY_FEATURES
Security features are enabled.

SILENCED
The silenced state.

Method Summary

static States	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static States[]	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

HELD

public static final States HELD

The held state.

Since:

5.1.0.0.29

See Also:

Hold

MUTED

public static final States MUTED

The muted state.

Since:

5.1.0.0.29

See Also:

Mute

SILENCED

public static final States SILENCED

The silenced state.

Since:

5.1.0.0.29

See Also:

Silence

OPERATOR

public static final States OPERATOR

The operator state. The ConferencingObject belongs to an Operator.

Since:

5.1.0.0.41

See Also:

Operator

MODERATOR

public static final States MODERATOR

The moderator state.

Since:

5.1.0.0.29

See Also:

Moderator

AUTHENTICATING

public static final States AUTHENTICATING

The state related to an EndPoint that has not completed authentication and therefore we don't know if they are a MODERATOR or a conferee.

Since:

5.1.0.0.44

See Also:

MODERATOR

OBSERVED

public static final States OBSERVED

The observed state.

Since:

5.1.0.0.29

See Also:

Observe

ACCESSED

public static final States ACCESSED

The accessed state.

Since:

5.1.0.0.29

See Also:

Access

DETAILS_PROTECTED

public static final States DETAILS_PROTECTED

The conference details are protected from modification.

Since:

5.1.0.0.29

See Also:

ProtectDetails

SECURED_MODE

public static final States SECURED_MODE

The conference secured state.

Since:

5.1.0.0.29

See Also:

SecuredMode

SECURITY_FEATURES

public static final States SECURITY_FEATURES

Security features are enabled.

Since:

5.1.0.0.29

See Also:

SecurityFeatures

LECTURE_MODE

public static final States LECTURE_MODE

The conference lecture mode state.

Since:

5.1.0.0.29

See Also:

LectureMode

OBSERVE_ONLY

public static final States OBSERVE_ONLY

The observe only state.

Since:

5.1.0.0.29

See Also:

Mute, Silence, LectureMode, PlaybackModeStart, Hold

QA_MODE

public static final States QA_MODE

The question and answer session state.

Since:

5.1.0.0.29

See Also:

QAModeStart

QA_HAS_QUESTION

public static final States QA_HAS_QUESTION

The question state.

Since:

5.1.0.0.29

See Also:

QANextQuestion

RECORDING_MODE

public static final States RECORDING_MODE

The recording state.

Since:

5.1.0.0.29

See Also:

RecordingModeStart

PLAYBACK_MODE

public static final States PLAYBACK_MODE

The playing state.

Since:

5.1.0.0.29

See Also:

PlaybackModeStart

PAUSED

public static final States PAUSED

The paused state.

Since:

5.1.0.0.29

See Also:

PlaybackModePause, RecordingModePause

POLLING_MODE

public static final States POLLING_MODE

The polling state.

Since:

5.1.0.0.29

See Also:

PollingModeStart

MESSAGE_PLAYBACK

public static final States MESSAGE_PLAYBACK

When an EndPoint or a Conference is being played a message...

Since:

5.1.0.0.31

ENTERING_DTMF

public static final States ENTERING_DTMF

When an EndPoint is inputting DTMF.

Since:

5.1.0.0.37

ESTABLISHING

public static final States ESTABLISHING

When an call to an EndPoint is being established.

AUTOMATIC_GAIN_CONTROL_MODE

public static final States AUTOMATIC_GAIN_CONTROL_MODE

When gain is controlled automatically.

Since:

5.1.0.0.37

RECORD_PARTICIPANT_NAMES

public static final States RECORD_PARTICIPANT_NAMES

The conference will attempt to record participant names when they initially join the conference.

Since:

5.1.0.0.47

MODERATOR_DISCONNECT_MODE

public static final States MODERATOR_DISCONNECT_MODE

The conference will be disconnected when the last moderator disconnects.

Since:

5.1.0.0.37

FAULTED

public static final States FAULTED

The ConferencingObject has been marked as requiring maintenance. Typically this would be applied to an EndPoint to indicate, for example, that the physical resource which the EndPoint is using is faulty. This state is more relevant for traditional telephony conferencing, where for example a line on a switch may be suffering from a fault.

Since:

5.1.0.0.40

CONFERENCING_PROVIDER_LINK

public static final States CONFERENCING_PROVIDER_LINK

The EndPoint is one end of a link to a second ConferencingProvider and can be used to share the media of two Conference

Since:

5.1.0.0.60

ENFORCE_PARTICIPANT_LIMITS

public static final States ENFORCE_PARTICIPANT_LIMITS

Tells a Conference that it MUST enforce the limits to the number of participants to that Conference.

Tells the {Connection that all Conferences on the Connection MUST enforce the limits to the number of participants of those Conferences.

Since:

5.1.0.0.60

PASSTHROUGH_DTMF

public static final States PASSTHROUGH_DTMF

Tells a Conference with audio media that it should not clamp DTMF received from each EndPoint but should instead pass any DTMF digits through to the conference. When a conference is in this state, the REGENERATE_DTMF state is effectively ignored. This state is only valid for Conferences with at least one audio media stream.

Since:

5.1.1.0.1

REGENERATE_DTMF

public static final States REGENERATE_DTMF

This state indicates the re-synthesis of any DTMF tones that have been clamped (i.e. muted) from the other EndPoints in the Conference. This state does not have any effect when the Conference is in the PASSTHROUGH_DTMF state. When applied to an EndPoint, the state directly controls the re-synthesis for that EndPoint. When applied to a Conference, the state defines the default value to be applied to all EndPoints joining the Conference. This state is only valid for Conferences with at least one audio media stream.

Since:

5.1.1.0.1

MEASURING_DTMF_SIGNAL_TO_NOISE_RATIO

public static final States MEASURING_DTMF_SIGNAL_TO_NOISE_RATIO

This state indicates whether any DTMFEvents for an EndPoint will include the signal-to-noise ratio of the DTMF tones.

Since:

5.1.1.0.1

MEASURING_SIGNAL_TO_NOISE_RATIO

public static final States MEASURING_SIGNAL_TO_NOISE_RATIO

This state indicates when the signal-to-noise ration of an EndPoint is being measured.

Since:

5.1.1.0.1

AVAILABLE_FOR_RECORDING

public static final States AVAILABLE_FOR_RECORDING

This state indicates that the record playback server is available for recording.

Since:

5.1.1.3.2

AVAILABLE_FOR_PLAYBACK

public static final States AVAILABLE_FOR_PLAYBACK

This state indicates that the record playback server is available for playback.

Since:

5.1.1.3.2

IDENTIFIED_PARTICIPANT_MODE

public static final States IDENTIFIED_PARTICIPANT_MODE

This state indicates that the conference requires all particpants to enter their unique participant identifier.

Since:

5.2.0.0.1

SECURED_IDENTIFIED_PARTICIPANT_MODE

public static final States SECURED_IDENTIFIED_PARTICIPANT_MODE

This state indicates that the conference requires all particpants to enter their unique participant identifier and secret PIN.

Since:

5.2.0.0.1

Method Detail

values

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

Returns:

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

valueOf

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