com.askfast.askfastapi.model

Enum MediaProperty.MediaPropertyKey

java.lang.Object

java.lang.Enum<MediaProperty.MediaPropertyKey>

com.askfast.askfastapi.model.MediaProperty.MediaPropertyKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MediaProperty.MediaPropertyKey>

Enclosing class:

MediaProperty

public static enum MediaProperty.MediaPropertyKey
extends java.lang.Enum<MediaProperty.MediaPropertyKey>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANSWER_INPUT defines if the answer is given via dtmf, text etc
ANSWER_INPUT_MAX_LENGTH
ANSWER_INPUT_MIN_LENGTH defines the length of th answer input.
CALL_LENGTH Define how long you want the call to be in Secs
CONFERENCE_END_ON_DISCONNECT The conference ends when this flag is set to true.
CONFERENCE_EXIT_ON_STAR Any time during the conference, if this is set to true.
CONFERENCE_ROOM_NAME The conference room name that has to be used to add a call to.
CONFERENCE_START_ON_CONNECT The conference starts when this flag is set to true.
CONFERENCE_WAIT_URL A valid url must be set against this key.
DTMF_TERMINATE boolean flag to indicate if the call should terminate when a dtmf is pressed
FINISH_ON_KEY Stop collecting user input once this key is pressed
MACHINE_DETECTION
RECORD_FROM_ANSWER Do voice recording on single channel when the phone is answered.
RECORD_FROM_ANSWER_DUAL Do voice Recording on separate channel
RECORD_FROM_RINGING Start the voice recording when the phone starts ringing
RECORD_FROM_RINGING_DUAL Start the voice recording when the phone starts ringing.
RECORD_FROM_START Used to record the conference call.
RETRY_LIMIT defines the number of times the question should repeat in case of a wrong answer input.
SPEECH_HINTS Used to pass hints to voice to text engine.
SPEECH_TIMEOUT Amount of time the call must collect caller's input.
TIMEOUT defines the timeout associated with the call
TRANSCRIPT If this is set to true.
TRANSCRIPT_LANG The langauge of the recording file.
TRANSCRIPT_SERVICE_TYPE The type of transcription service to use.
TRANSCRIPT_URL The URL to which the transcript is POSTed to.
TSS_SPEED defines the speed at which the TTS is spoken by the TTS engine
TYPE defines a subtype for the question type.
USE_EXTERNAL_CALLERID defines which caller id should be when redirecting a call.
USE_PRECONNECT Pre-connect message.
VOICE_MESSAGE_BEEP boolean flag to indicate if a voice mssage start should be indicated by a beep or not
VOICE_MESSAGE_LENGTH defines the length of the voicemail to be recorded
VOICE_MESSAGE_URL defines the endpoint where the recording message must be posted to

Method Summary

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

TIMEOUT

public static final MediaProperty.MediaPropertyKey TIMEOUT

defines the timeout associated with the call

ANSWER_INPUT

public static final MediaProperty.MediaPropertyKey ANSWER_INPUT

defines if the answer is given via dtmf, text etc

ANSWER_INPUT_MIN_LENGTH

public static final MediaProperty.MediaPropertyKey ANSWER_INPUT_MIN_LENGTH

defines the length of th answer input. Typically dtmf

ANSWER_INPUT_MAX_LENGTH

public static final MediaProperty.MediaPropertyKey ANSWER_INPUT_MAX_LENGTH

TYPE

public static final MediaProperty.MediaPropertyKey TYPE

defines a subtype for the question type.
E.g. open question with type: audio refers to voicemail

VOICE_MESSAGE_LENGTH

public static final MediaProperty.MediaPropertyKey VOICE_MESSAGE_LENGTH

defines the length of the voicemail to be recorded

VOICE_MESSAGE_URL

public static final MediaProperty.MediaPropertyKey VOICE_MESSAGE_URL

defines the endpoint where the recording message must be posted to

RETRY_LIMIT

public static final MediaProperty.MediaPropertyKey RETRY_LIMIT

defines the number of times the question should repeat in case of a wrong answer input. works only for phonecalls so as to end a call with repeated input errors.

VOICE_MESSAGE_BEEP

public static final MediaProperty.MediaPropertyKey VOICE_MESSAGE_BEEP

boolean flag to indicate if a voice mssage start should be indicated by a beep or not

DTMF_TERMINATE

public static final MediaProperty.MediaPropertyKey DTMF_TERMINATE

boolean flag to indicate if the call should terminate when a dtmf is pressed

TSS_SPEED

public static final MediaProperty.MediaPropertyKey TSS_SPEED

defines the speed at which the TTS is spoken by the TTS engine

USE_EXTERNAL_CALLERID

public static final MediaProperty.MediaPropertyKey USE_EXTERNAL_CALLERID

defines which caller id should be when redirecting a call. If this is set to true the caller id of the connected user will be used. If false the adapterid caller id will be used. (Default: false)

USE_PRECONNECT

public static final MediaProperty.MediaPropertyKey USE_PRECONNECT

Pre-connect message. Gives opertunity to play a message before connecting the redirected call

CONFERENCE_ROOM_NAME

public static final MediaProperty.MediaPropertyKey CONFERENCE_ROOM_NAME

The conference room name that has to be used to add a call to.

CONFERENCE_START_ON_CONNECT

public static final MediaProperty.MediaPropertyKey CONFERENCE_START_ON_CONNECT

The conference starts when this flag is set to true. If not found, the conference starts as soon as there are two people in the conference

CONFERENCE_END_ON_DISCONNECT

public static final MediaProperty.MediaPropertyKey CONFERENCE_END_ON_DISCONNECT

The conference ends when this flag is set to true. If not found, the conference ends as soon as all participants leave the conference

CONFERENCE_WAIT_URL

public static final MediaProperty.MediaPropertyKey CONFERENCE_WAIT_URL

A valid url must be set against this key. This audio is played when participant is waiting in a conference room to be connected to other participants

CALL_LENGTH

public static final MediaProperty.MediaPropertyKey CALL_LENGTH

Define how long you want the call to be in Secs

CONFERENCE_EXIT_ON_STAR

public static final MediaProperty.MediaPropertyKey CONFERENCE_EXIT_ON_STAR

Any time during the conference, if this is set to true. Will exit the conference and perform the next sequence of control events

TRANSCRIPT

public static final MediaProperty.MediaPropertyKey TRANSCRIPT

If this is set to true. Will generate the call transcript and POST it to the TRANSCRIPT_URL accepted values are true & false. default is false

TRANSCRIPT_URL

public static final MediaProperty.MediaPropertyKey TRANSCRIPT_URL

The URL to which the transcript is POSTed to. This is used only if TRANSCRIPT is set to true

TRANSCRIPT_LANG

public static final MediaProperty.MediaPropertyKey TRANSCRIPT_LANG

The langauge of the recording file. Default is en-GB

TRANSCRIPT_SERVICE_TYPE

public static final MediaProperty.MediaPropertyKey TRANSCRIPT_SERVICE_TYPE

The type of transcription service to use. It is used if transcript is set as true. Check for TRANSCRIPTION_SERVICES enum for various models. If null, Model1_G is used.

RECORD_FROM_ANSWER_DUAL

public static final MediaProperty.MediaPropertyKey RECORD_FROM_ANSWER_DUAL

Do voice Recording on separate channel

RECORD_FROM_ANSWER

public static final MediaProperty.MediaPropertyKey RECORD_FROM_ANSWER

Do voice recording on single channel when the phone is answered.

RECORD_FROM_RINGING

public static final MediaProperty.MediaPropertyKey RECORD_FROM_RINGING

Start the voice recording when the phone starts ringing

RECORD_FROM_RINGING_DUAL

public static final MediaProperty.MediaPropertyKey RECORD_FROM_RINGING_DUAL

Start the voice recording when the phone starts ringing. Do the voice recording of the calls on separate channel.

RECORD_FROM_START

public static final MediaProperty.MediaPropertyKey RECORD_FROM_START

Used to record the conference call. Starts recording when the conference call starts.

MACHINE_DETECTION

public static final MediaProperty.MediaPropertyKey MACHINE_DETECTION

FINISH_ON_KEY

public static final MediaProperty.MediaPropertyKey FINISH_ON_KEY

Stop collecting user input once this key is pressed

SPEECH_TIMEOUT

public static final MediaProperty.MediaPropertyKey SPEECH_TIMEOUT

Amount of time the call must collect caller's input.

SPEECH_HINTS

public static final MediaProperty.MediaPropertyKey SPEECH_HINTS

Used to pass hints to voice to text engine. It must be set of comma separated words.

Method Detail

values

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

Returns:

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

valueOf

public static MediaProperty.MediaPropertyKey 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

fromJson

public static MediaProperty.MediaPropertyKey fromJson(java.lang.String name)