com.amazonaws.mobileconnectors.lex.interactionkit.ui

Class InteractiveVoiceViewAdapter

java.lang.Object

com.amazonaws.mobileconnectors.lex.interactionkit.ui.InteractiveVoiceViewAdapter

All Implemented Interfaces:

android.view.View.OnClickListener, AudioPlaybackListener, InteractionListener, MicrophoneListener

public class InteractiveVoiceViewAdapter
extends Object
implements InteractionListener, AudioPlaybackListener, MicrophoneListener, android.view.View.OnClickListener

This class helps to easily interface the InteractiveVoiceView view's with the Amazon Lex client. It manages the client states and delivers results through separate callbacks. This implementation of the adapter offers only voice for voice out operations only.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	state
protected static int	STATE_AUDIO_PLAYBACK
protected static int	STATE_AWAITING_RESPONSE
protected static int	STATE_LISTENING
protected static int	STATE_NOT_READY
protected static int	STATE_READY

Method Summary

Modifier and Type	Method and Description
protected void	cancel() Cancel current dialog.
protected void	createInteractionClient() Creates the interaction client, uses default interaction config setting InteractionConfig .
String	getAwsRegion() Get the AWS regions set for this adapter.
static InteractiveVoiceViewAdapter	getInstance(android.content.Context context, InteractiveVoiceView micButton)
void	onAudioPlayBackCompleted() Called after audio playback ends.
void	onAudioPlaybackError(Exception e) Called when audion playback fails.
void	onAudioPlaybackStarted() Called when audio playback has started.
void	onClick(android.view.View v)
void	onInteractionError(Response response, Exception e) This method is invoked on error.
void	onMicrophoneError(Exception e) Indicates an error when recording sound on the microphone.
void	onReadyForFulfillment(Response response) This is invoked when all information required to fulfill a transaction has been recovered.
void	onRecordingEnd() This is invoked when the client has stopped recording.
void	onSoundLevelChanged(double soundLevel) This is invoked to indicate a change in the sound level.
void	promptUserToRespond(Response response, LexServiceContinuation continuation) This is invoked when input is required from the user.
void	readyForRecording() This is invoked when the client is ready for recording.
protected void	reset() Reset client.
void	setAwsRegion(String awsRegion) Set the AWS region where the Amazon Lex bot has been setup.
void	setCredentialProvider(AWSCredentialsProvider credentialsProvider) Set credentials provider.
void	setInteractionConfig(InteractionConfig interactionConfig) Set interaction config.
void	setSessionAttributes(Map<String,String> sessionAttributes) Set session attributes, these will be picked for the next dialog transaction.
protected void	setVoiceListener(InteractiveVoiceView.InteractiveVoiceListener voiceListener) Assign a listener for the voice interactions with the Amazon Lex bot.
void	startedRecording() This is invoked when the client has started recording.
protected void	validateAppData() Validates app details.

Methods inherited from class java.lang.Object

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

Field Detail

state

protected int state

STATE_NOT_READY

protected static final int STATE_NOT_READY

See Also:

Constant Field Values

STATE_READY

protected static final int STATE_READY

See Also:

Constant Field Values

STATE_LISTENING

protected static final int STATE_LISTENING

See Also:

Constant Field Values

STATE_AUDIO_PLAYBACK

protected static final int STATE_AUDIO_PLAYBACK

See Also:

Constant Field Values

STATE_AWAITING_RESPONSE

protected static final int STATE_AWAITING_RESPONSE

See Also:

Constant Field Values

Method Detail

getInstance

public static InteractiveVoiceViewAdapter getInstance(android.content.Context context,
                                                      InteractiveVoiceView micButton)

onAudioPlaybackStarted

public void onAudioPlaybackStarted()

Description copied from interface: AudioPlaybackListener

Called when audio playback has started.

Specified by:

onAudioPlaybackStarted in interface AudioPlaybackListener

onAudioPlayBackCompleted

public void onAudioPlayBackCompleted()

Description copied from interface: AudioPlaybackListener

Called after audio playback ends.

Specified by:

onAudioPlayBackCompleted in interface AudioPlaybackListener

onAudioPlaybackError

public void onAudioPlaybackError(Exception e)

Description copied from interface: AudioPlaybackListener

Called when audion playback fails.

Specified by:

onAudioPlaybackError in interface AudioPlaybackListener

Parameters:

e - Exception.

onReadyForFulfillment

public void onReadyForFulfillment(Response response)

Description copied from interface: InteractionListener

This is invoked when all information required to fulfill a transaction has been recovered.

Specified by:

onReadyForFulfillment in interface InteractionListener

Parameters:

response - Response, contains the service response.

promptUserToRespond

public void promptUserToRespond(Response response,
                                LexServiceContinuation continuation)

Description copied from interface: InteractionListener

This is invoked when input is required from the user.

Specified by:

promptUserToRespond in interface InteractionListener

Parameters:

response - Response, contains the service response.

continuation - LexServiceContinuation, allows to continue with the current transaction.

onInteractionError

public void onInteractionError(Response response,
                               Exception e)

Description copied from interface: InteractionListener

This method is invoked on error.

Specified by:

onInteractionError in interface InteractionListener

Parameters:

response - Response, contains the service response.

e - error reported as Exception.

readyForRecording

public void readyForRecording()

Description copied from interface: MicrophoneListener

This is invoked when the client is ready for recording.

Specified by:

readyForRecording in interface MicrophoneListener

startedRecording

public void startedRecording()

Description copied from interface: MicrophoneListener

This is invoked when the client has started recording.

Specified by:

startedRecording in interface MicrophoneListener

onRecordingEnd

public void onRecordingEnd()

Description copied from interface: MicrophoneListener

This is invoked when the client has stopped recording.

Specified by:

onRecordingEnd in interface MicrophoneListener

onSoundLevelChanged

public void onSoundLevelChanged(double soundLevel)

Description copied from interface: MicrophoneListener

This is invoked to indicate a change in the sound level.

Specified by:

onSoundLevelChanged in interface MicrophoneListener

Parameters:

soundLevel - Sound level as a Double.

onMicrophoneError

public void onMicrophoneError(Exception e)

Description copied from interface: MicrophoneListener

Indicates an error when recording sound on the microphone.

Specified by:

onMicrophoneError in interface MicrophoneListener

Parameters:

e - Error as an Exception.

onClick

public void onClick(android.view.View v)

Specified by:

onClick in interface android.view.View.OnClickListener

validateAppData

protected void validateAppData()

Validates app details.

Override this method to implement custom attribute verification.

createInteractionClient

protected void createInteractionClient()

Creates the interaction client, uses default interaction config setting InteractionConfig .

cancel

protected void cancel()

Cancel current dialog.

reset

protected void reset()

Reset client.

setVoiceListener

protected void setVoiceListener(InteractiveVoiceView.InteractiveVoiceListener voiceListener)

Assign a listener for the voice interactions with the Amazon Lex bot.

Parameters:

voiceListener -

setCredentialProvider

public void setCredentialProvider(AWSCredentialsProvider credentialsProvider)

Set credentials provider.

Parameters:

credentialsProvider -

setInteractionConfig

public void setInteractionConfig(InteractionConfig interactionConfig)

Set interaction config.

Parameters:

interactionConfig - The interaction config.

setSessionAttributes

public void setSessionAttributes(Map<String,String> sessionAttributes)

Set session attributes, these will be picked for the next dialog transaction.

Parameters:

sessionAttributes -

setAwsRegion

public void setAwsRegion(String awsRegion)

Set the AWS region where the Amazon Lex bot has been setup.

Parameters:

awsRegion -

getAwsRegion

public String getAwsRegion()

Get the AWS regions set for this adapter.

Returns:

The AWS region, String.