com.zoiper.zdk.Types

Enum AutomaticGainControlType

java.lang.Object

java.lang.Enum<AutomaticGainControlType>

com.zoiper.zdk.Types.AutomaticGainControlType

All Implemented Interfaces:

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

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

Automatic Gain Control (AGC) types

Enum Constant Summary

Enum Constants

Enum Constant and Description
Hardware Enable hardware/system Automatic Gain Control.
Off Disable Automatic Gain Control.
SoftwareAnalog An adaptive analog gain controler which controls the gain by manipulating the volume control of the hardware mixer.
SoftwareDigitalV1 An adaptive digital gain controler.
SoftwareDigitalV2 This is a more modern adaptive gain controller that is changing the gain only digitally.
SoftwareHybrid This is a combination of SoftwareAnalog and SoftwareDigitalV2 modes.

Method Summary

Modifier and Type	Method and Description
static AutomaticGainControlType	fromInt(int i)
static AutomaticGainControlType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AutomaticGainControlType[]	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

Off

public static final AutomaticGainControlType Off

Disable Automatic Gain Control. Neither software nor hardware/system gain will be used.

SoftwareAnalog

public static final AutomaticGainControlType SoftwareAnalog

An adaptive analog gain controler which controls the gain by manipulating the volume control of the hardware mixer. It is advised to limit the user from changing the volume. If the volume control cannot be manipulated the SoftwareDigitalV1 is used instead automatically.

SoftwareDigitalV1

public static final AutomaticGainControlType SoftwareDigitalV1

An adaptive digital gain controler. It cannot apply additional fixed gain and the gain parameter is not takin into account.

SoftwareDigitalV2

public static final AutomaticGainControlType SoftwareDigitalV2

This is a more modern adaptive gain controller that is changing the gain only digitally. It can apply additional fixed gain taken from the gain parameter.

SoftwareHybrid

public static final AutomaticGainControlType SoftwareHybrid

This is a combination of SoftwareAnalog and SoftwareDigitalV2 modes.

Hardware

public static final AutomaticGainControlType Hardware

Enable hardware/system Automatic Gain Control. Works only on iOS and has no effect on all other platforms!

Method Detail

values

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

Returns:

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

valueOf

public static AutomaticGainControlType 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 AutomaticGainControlType fromInt(int i)