com.nuecho.rivr.voicexml.turn.output

Class Interaction.Builder

java.lang.Object

com.nuecho.rivr.voicexml.turn.output.Interaction.Builder

Enclosing class:

Interaction

public static final class Interaction.Builder
extends Object

Builder used to ease the creation of instances of Interaction.

Building an Interaction implies the following steps:

• Add some prompts
  • For each prompt, speech/DTMF recognition can be specified (thus enabling barge-in when the prompt is played).
• Once all prompts are added, optionally specify either:
  • a final recognition window (speech or DTMF)
  • a final recording window

At any time, it is possible to change the current language used for prompts (relevant to speech synthesis) and the barge-in type, i.e. speech or hotword.

This can be translated to:

 Builder builder = new Builder();
 builder.addPrompt(...);
 builder.addPrompt(...);
 //... repeat as needed
 Interaction interaction = builder.build(...);
 

Constructor Summary

Constructors

Constructor and Description
Builder(String name)

Method Summary

Modifier and Type	Method and Description
Interaction.Builder	addPrompt(AudioItem... audioItems) Adds a prompt without any DTMF nor speech recognition (no barge-in).
Interaction.Builder	addPrompt(DtmfRecognition dtmfRecognition, AudioItem... audioItems) Adds a prompt with DTMF recognition only.
Interaction.Builder	addPrompt(DtmfRecognition dtmfRecognition, List<? extends AudioItem> audioItems) Adds a prompt with DTMF recognition only.
Interaction.Builder	addPrompt(DtmfRecognition dtmfRecognition, SpeechRecognition speechRecognition, AudioItem... audioItems) Adds a prompt with both DTMF and speech recognition.
Interaction.Builder	addPrompt(DtmfRecognition dtmfRecognition, SpeechRecognition speechRecognition, List<? extends AudioItem> audioItems) Adds a prompt with both DTMF and speech recognition.
Interaction.Builder	addPrompt(List<? extends AudioItem> audioItems) Adds a prompt without any DTMF nor speech recognition (no barge-in).
Interaction.Builder	addPrompt(SpeechRecognition speechRecognition, AudioItem... audioItems) Adds a prompt with speech recognition only.
Interaction.Builder	addPrompt(SpeechRecognition speechRecognition, List<? extends AudioItem> audioItems) Adds a prompt with speech recognition only.
Interaction	build() Builds the interaction.
Interaction	build(DtmfRecognition dtmfRecognition, Duration noinputTimeout, AudioItem... acknowledgeAudioItems) Builds the interaction.
Interaction	build(DtmfRecognition dtmfRecognition, Duration noinputTimeout, List<? extends AudioItem> acknowledgeAudioItems) Builds the interaction.
Interaction	build(DtmfRecognition dtmfRecognition, SpeechRecognition speechRecognition, Duration noinputTimeout, AudioItem... acknowledgeAudioItems) Builds the interaction.
Interaction	build(DtmfRecognition dtmfRecognition, SpeechRecognition speechRecognition, Duration noinputTimeout, List<? extends AudioItem> acknowledgeAudioItems) Builds the interaction.
Interaction	build(Recording recording, Duration noinputTimeout, AudioItem... acknowledgeAudioItems) Builds the interaction.
Interaction	build(Recording recording, Duration noinputTimeout, List<? extends AudioItem> acknowledgeAudioItems) Builds the interaction.
Interaction	build(SpeechRecognition speechRecognition, Duration noinputTimeout, AudioItem... acknowledgeAudioItems) Builds the interaction.
Interaction	build(SpeechRecognition speechRecognition, Duration noinputTimeout, List<? extends AudioItem> acknowledgeAudioItems) Builds the interaction.
Interaction.Builder	setBargeInType(Interaction.BargeInType bargeInType) Sets the barge-in type to either Interaction.BargeInType.speech or Interaction.BargeInType.hotword for the prompts that will be added using one of the addPrompt(...) methods.
Interaction.Builder	setLanguage(String language) Sets the language code for the prompts that will be added using one of the addPrompt(...) methods.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(String name)

Method Detail

setBargeInType

public Interaction.Builder setBargeInType(Interaction.BargeInType bargeInType)

Sets the barge-in type to either Interaction.BargeInType.speech or Interaction.BargeInType.hotword for the prompts that will be added using one of the addPrompt(...) methods.

Note: When a Interaction.Builder is created, the default value for this flag is null, meaning the barge-in type will be platform-dependant.

Parameters:

bargeInType -

• Interaction.BargeInType.speech
• Interaction.BargeInType.hotword
• null reverts to platform default value

Returns:

this builder

setLanguage

public Interaction.Builder setLanguage(String language)

Sets the language code for the prompts that will be added using one of the addPrompt(...) methods.

Note: When a @{link Builder} is created, the default value for this property is null, i.e. no explicit language code will be generated in the VoiceXML thus relying on the platform-specific default language code.

Parameters:

language - language code for this prompt. null if language should be reset to platform-specific default value for the prompts to be added.

Returns:

this builder

addPrompt

public Interaction.Builder addPrompt(DtmfRecognition dtmfRecognition,
                                     AudioItem... audioItems)

Adds a prompt with DTMF recognition only.

Parameters:

dtmfRecognition - configuration for the DTMF recognition

audioItems - audio items to be played during this prompt.

Returns:

this builder

addPrompt

public Interaction.Builder addPrompt(DtmfRecognition dtmfRecognition,
                                     List<? extends AudioItem> audioItems)

Adds a prompt with DTMF recognition only.

Parameters:

dtmfRecognition - configuration for the DTMF recognition

audioItems - audio items to be played during this prompt.

Returns:

this builder

addPrompt

public Interaction.Builder addPrompt(SpeechRecognition speechRecognition,
                                     AudioItem... audioItems)

Adds a prompt with speech recognition only.

Parameters:

speechRecognition - configuration for the speech recognition

audioItems - audio items to be played during this prompt.

Returns:

this builder

addPrompt

public Interaction.Builder addPrompt(SpeechRecognition speechRecognition,
                                     List<? extends AudioItem> audioItems)

Adds a prompt with speech recognition only.

Parameters:

speechRecognition - configuration for the speech recognition

audioItems - audio items to be played during this prompt.

Returns:

this builder

addPrompt

public Interaction.Builder addPrompt(DtmfRecognition dtmfRecognition,
                                     SpeechRecognition speechRecognition,
                                     AudioItem... audioItems)

Adds a prompt with both DTMF and speech recognition.

Parameters:

speechRecognition - configuration for the speech recognition or null to disable DTMF recognition.

dtmfRecognition - configuration for the DTMF recognition or null to disable DTMF recognition.

audioItems - audio items to be played during this prompt.

Returns:

this builder

addPrompt

public Interaction.Builder addPrompt(DtmfRecognition dtmfRecognition,
                                     SpeechRecognition speechRecognition,
                                     List<? extends AudioItem> audioItems)

Adds a prompt with both DTMF and speech recognition.

Parameters:

speechRecognition - configuration for the speech recognition or null to disable DTMF recognition.

dtmfRecognition - configuration for the DTMF recognition or null to disable DTMF recognition.

audioItems - audio items to be played during this prompt.

Returns:

this builder

addPrompt

public Interaction.Builder addPrompt(AudioItem... audioItems)

Adds a prompt without any DTMF nor speech recognition (no barge-in).

Parameters:

audioItems - audio items to be played during this prompt.

Returns:

this builder

addPrompt

public Interaction.Builder addPrompt(List<? extends AudioItem> audioItems)

Adds a prompt without any DTMF nor speech recognition (no barge-in).

Parameters:

audioItems - audio items to be played during this prompt.

Returns:

this builder

build

public Interaction build(DtmfRecognition dtmfRecognition,
                         Duration noinputTimeout,
                         AudioItem... acknowledgeAudioItems)

Builds the interaction. This method adds a DTMF recognition window after the prompts.

Parameters:

dtmfRecognition - configuration for the DTMF recognition

noinputTimeout - timeout value before a noinput is generated.

acknowledgeAudioItems - audioItems to be played upon recognition

Returns:

the interaction

build

public Interaction build(SpeechRecognition speechRecognition,
                         Duration noinputTimeout,
                         AudioItem... acknowledgeAudioItems)

Builds the interaction. This method adds a speech recognition window after the prompts.

Parameters:

speechRecognition - configuration for the speech recognition

noinputTimeout - timeout value before a noinput is generated.

acknowledgeAudioItems - audioItems to be played upon recognition

Returns:

the interaction

build

public Interaction build(DtmfRecognition dtmfRecognition,
                         Duration noinputTimeout,
                         List<? extends AudioItem> acknowledgeAudioItems)

Builds the interaction. This method adds a DTMF recognition window after the prompts.

Parameters:

dtmfRecognition - configuration for the DTMF recognition

noinputTimeout - timeout value before a noinput is generated.

acknowledgeAudioItems - audioItems to be played upon recognition

Returns:

the interaction

build

public Interaction build(SpeechRecognition speechRecognition,
                         Duration noinputTimeout,
                         List<? extends AudioItem> acknowledgeAudioItems)

Builds the interaction. This method adds a speech recognition window after the prompts.

Parameters:

speechRecognition - configuration for the speech recognition

noinputTimeout - timeout value before a noinput is generated.

acknowledgeAudioItems - audioItems to be played upon recognition

Returns:

the interaction

build

public Interaction build(DtmfRecognition dtmfRecognition,
                         SpeechRecognition speechRecognition,
                         Duration noinputTimeout,
                         AudioItem... acknowledgeAudioItems)

Builds the interaction. This method adds a speech and DTMF recognition window after the prompts.

Parameters:

speechRecognition - configuration for the speech recognition

dtmfRecognition - configuration for the DTMF recognition

noinputTimeout - timeout value before a noinput is generated.

acknowledgeAudioItems - audioItems to be played upon recognition

Returns:

the interaction

build

public Interaction build(DtmfRecognition dtmfRecognition,
                         SpeechRecognition speechRecognition,
                         Duration noinputTimeout,
                         List<? extends AudioItem> acknowledgeAudioItems)

Builds the interaction. This method adds a speech and DTMF recognition window after the prompts.

Parameters:

speechRecognition - configuration for the speech recognition

dtmfRecognition - configuration for the DTMF recognition

noinputTimeout - timeout value before a noinput is generated.

acknowledgeAudioItems - audioItems to be played upon recognition

Returns:

the interaction

build

public Interaction build(Recording recording,
                         Duration noinputTimeout,
                         AudioItem... acknowledgeAudioItems)

Builds the interaction. This method adds a recording window after the prompts.

Parameters:

recording - configuration for the recording

noinputTimeout - timeout value before a noinput is generated.

acknowledgeAudioItems - audioItems to be played upon recording completion

Returns:

the interaction

build

public Interaction build(Recording recording,
                         Duration noinputTimeout,
                         List<? extends AudioItem> acknowledgeAudioItems)

Builds the interaction. This method adds a recording window after the prompts.

Parameters:

recording - configuration for the recording

noinputTimeout - timeout value before a noinput is generated.

acknowledgeAudioItems - audioItems to be played upon recording completion

Returns:

the interaction

build

public Interaction build()

Builds the interaction. This method does not allow any recording nor recognition after the prompts.

Returns:

the interaction