Package org.linphone.core

Enum ParticipantDeviceState

java.lang.Object

java.lang.Enum<ParticipantDeviceState>

org.linphone.core.ParticipantDeviceState

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

ParticipantDeviceState is used to list all states a participant device
can be in

Enum Constant Summary

Enum Constants

Enum Constant	Description
Alerting	180 Ringing
Joining	an INVITE has been sent
Leaving	A BYE is pending.
Left	The Session is terminated.
MutedByFocus	Some medias have been muted by the focus.
OnHold	the SIP session has been concluded, participant is not media mixed
Present	the SIP session has been concluded, participant is part of the conference
ScheduledForJoining	Initial state for the server group chatroom, when the participant has not yet been INVITEd.
ScheduledForLeaving	Transitional state for a participant that will receive a BYE shortly.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	mValue

Method Summary

Modifier and Type	Method	Description
static ParticipantDeviceState	fromInt(int value)
protected static ParticipantDeviceState[]	fromIntArray(int[] values)
int	toInt()
protected static int[]	toIntArray(ParticipantDeviceState[] values)
static ParticipantDeviceState	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ParticipantDeviceState[]	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

Joining

public static final ParticipantDeviceState Joining

an INVITE has been sent

Present

public static final ParticipantDeviceState Present

the SIP session has been concluded, participant is part of the conference

Leaving

public static final ParticipantDeviceState Leaving

A BYE is pending.

Left

public static final ParticipantDeviceState Left

The Session is terminated.

ScheduledForJoining

public static final ParticipantDeviceState ScheduledForJoining

Initial state for the server group chatroom, when the participant has not yet
been INVITEd.

ScheduledForLeaving

public static final ParticipantDeviceState ScheduledForLeaving

Transitional state for a participant that will receive a BYE shortly.

OnHold

public static final ParticipantDeviceState OnHold

the SIP session has been concluded, participant is not media mixed

Alerting

public static final ParticipantDeviceState Alerting

180 Ringing

MutedByFocus

public static final ParticipantDeviceState MutedByFocus

Some medias have been muted by the focus.

Field Detail

mValue

protected final int mValue

Method Detail

values

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

Returns:

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

valueOf

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

fromInt

public static ParticipantDeviceState fromInt(int value)
                                      throws java.lang.RuntimeException

Throws:

java.lang.RuntimeException

fromIntArray

protected static ParticipantDeviceState[] fromIntArray(int[] values)
                                                throws java.lang.RuntimeException

Throws:

java.lang.RuntimeException

toIntArray

protected static int[] toIntArray(ParticipantDeviceState[] values)
                           throws java.lang.RuntimeException

Throws:

java.lang.RuntimeException

toInt

public int toInt()