com.skype.api
Enum Participant.VoiceStatus

java.lang.Object
  extended by java.lang.Enum<Participant.VoiceStatus>
      extended by com.skype.api.Participant.VoiceStatus
All Implemented Interfaces:
EnumConverting, java.io.Serializable, java.lang.Comparable<Participant.VoiceStatus>
Enclosing class:
Participant

public static enum Participant.VoiceStatus
extends java.lang.Enum<Participant.VoiceStatus>
implements EnumConverting

Recognized values for the P_VOICE_STATUS property.


Enum Constant Summary
EARLY_MEDIA
          Participant is in process of joining current live session.
LISTENING
          Participant has joined the current live session but is currently not transmitting audio.
RINGING
          Participant has been invited to join the live session but has not yet accepted.
SPEAKING
          Participant has joined the current live session and is transmitting audio.
VOICE_AVAILABLE
          Participant is using a Skype client that supports audio.
VOICE_CONNECTING
          Participant is in process of joining current live session.
VOICE_NA
          Participant is using a Skype client with no audio capability.
VOICE_ON_HOLD
          Participant has joined the current live session but the audio is currently on hold.
VOICE_STOPPED
          Participant will be placed in this state for some seconds after live session has finished.
VOICE_UNKNOWN
          Participant voice status is not (yet) determined.
 
Field Summary
static int EARLY_MEDIA_VALUE
           
static int LISTENING_VALUE
           
static int RINGING_VALUE
           
static int SPEAKING_VALUE
           
static int VOICE_AVAILABLE_VALUE
           
static int VOICE_CONNECTING_VALUE
           
static int VOICE_NA_VALUE
           
static int VOICE_ON_HOLD_VALUE
           
static int VOICE_STOPPED_VALUE
           
static int VOICE_UNKNOWN_VALUE
           
 
Method Summary
 EnumConverting convert(int from)
           
static Participant.VoiceStatus get(int from)
           
 EnumConverting[] getArray(int size)
           
 EnumConverting getDefault()
           
 int getId()
           
static Participant.VoiceStatus valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Participant.VoiceStatus[] 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

VOICE_UNKNOWN

public static final Participant.VoiceStatus VOICE_UNKNOWN
Participant voice status is not (yet) determined.


VOICE_NA

public static final Participant.VoiceStatus VOICE_NA
Participant is using a Skype client with no audio capability.


VOICE_AVAILABLE

public static final Participant.VoiceStatus VOICE_AVAILABLE
Participant is using a Skype client that supports audio.


VOICE_CONNECTING

public static final Participant.VoiceStatus VOICE_CONNECTING
Participant is in process of joining current live session. This is a transitional state.


RINGING

public static final Participant.VoiceStatus RINGING
Participant has been invited to join the live session but has not yet accepted.


EARLY_MEDIA

public static final Participant.VoiceStatus EARLY_MEDIA
Participant is in process of joining current live session. This is another transitional state.


LISTENING

public static final Participant.VoiceStatus LISTENING
Participant has joined the current live session but is currently not transmitting audio.


SPEAKING

public static final Participant.VoiceStatus SPEAKING
Participant has joined the current live session and is transmitting audio. The UI can either use this state to display appropriate "speaking" notification, or alternatively use Participant.P_SOUND_LEVEL if you want your speaking indicator to also reflect audio volume coming from the Participant.


VOICE_ON_HOLD

public static final Participant.VoiceStatus VOICE_ON_HOLD
Participant has joined the current live session but the audio is currently on hold.


VOICE_STOPPED

public static final Participant.VoiceStatus VOICE_STOPPED
Participant will be placed in this state for some seconds after live session has finished. This is another transitional state.

Field Detail

VOICE_UNKNOWN_VALUE

public static final int VOICE_UNKNOWN_VALUE
See Also:
Constant Field Values

VOICE_NA_VALUE

public static final int VOICE_NA_VALUE
See Also:
Constant Field Values

VOICE_AVAILABLE_VALUE

public static final int VOICE_AVAILABLE_VALUE
See Also:
Constant Field Values

VOICE_CONNECTING_VALUE

public static final int VOICE_CONNECTING_VALUE
See Also:
Constant Field Values

RINGING_VALUE

public static final int RINGING_VALUE
See Also:
Constant Field Values

EARLY_MEDIA_VALUE

public static final int EARLY_MEDIA_VALUE
See Also:
Constant Field Values

LISTENING_VALUE

public static final int LISTENING_VALUE
See Also:
Constant Field Values

SPEAKING_VALUE

public static final int SPEAKING_VALUE
See Also:
Constant Field Values

VOICE_ON_HOLD_VALUE

public static final int VOICE_ON_HOLD_VALUE
See Also:
Constant Field Values

VOICE_STOPPED_VALUE

public static final int VOICE_STOPPED_VALUE
See Also:
Constant Field Values
Method Detail

values

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

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

valueOf

public static Participant.VoiceStatus 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

getId

public int getId()
Specified by:
getId in interface EnumConverting

getDefault

public EnumConverting getDefault()
Specified by:
getDefault in interface EnumConverting

convert

public EnumConverting convert(int from)
Specified by:
convert in interface EnumConverting

getArray

public EnumConverting[] getArray(int size)
Specified by:
getArray in interface EnumConverting

get

public static Participant.VoiceStatus get(int from)


Copyright © 2010, 2011 Skype Technologies. All Rights Reserved.