com.willblaschko.android.alexa

Class AlexaManager

java.lang.Object

com.willblaschko.android.alexa.AlexaManager

public class AlexaManager
extends java.lang.Object

The overarching instance that handles all the state when requesting intents to the Alexa Voice Service servers, it creates all the required instances and confirms that users are logged in and authenticated before allowing them to send intents. Beyond initialization, mostly it supplies wrapped helper functions to the other classes to assure authentication state.

Method Summary

Modifier and Type	Method and Description
void	checkLoggedIn(AsyncCallback<java.lang.Boolean,java.lang.Throwable> callback) Check if the user is logged in to the Amazon service, uses an async callback with a boolean to return response
static AlexaManager	getInstance(Context context, java.lang.String productId)
SpeechSendAudio	getSpeechSendAudio()
SpeechSendText	getSpeechSendText()
SpeechSendVoice	getSpeechSendVoice()
VoiceHelper	getVoiceHelper()
boolean	isRecording() Helper function to check if we're currently recording
void	logIn(AuthorizationCallback callback) Send a log in request to the Amazon Authentication Manager
void	sendAudioRequest(byte[] data, AsyncCallback<AvsResponse,java.lang.Exception> callback) Send raw audio data to the Alexa servers, this is a more advanced option to bypass other issues (like only one item being able to use the mic at a time).
void	sendAudioRequest(DataRequestBody requestBody, AsyncCallback<AvsResponse,java.lang.Exception> callback) Send streamed raw audio data to the Alexa servers, this is a more advanced option to bypass other issues (like only one item being able to use the mic at a time).
void	sendAudioRequest(int requestType, byte[] data, AsyncCallback<AvsResponse,java.lang.Exception> callback) Deprecated.
void	sendExpectSpeechTimeoutEvent(AsyncCallback<AvsResponse,java.lang.Exception> callback) Send confirmation that the device has timed out without receiving a speech request when expected
void	sendMutedEvent(boolean isMute, AsyncCallback<AvsResponse,java.lang.Exception> callback) Send a confirmation to the Alexa server that the mute state has been changed in response to a directive
void	sendOpenDownchannelDirective(AsyncCallback<AvsResponse,java.lang.Exception> callback) Send a get Directive request to the Alexa server to open a persistent connection
void	sendSynchronizeStateEvent(AsyncCallback<AvsResponse,java.lang.Exception> callback) Send a synchronize state Event request to Alexa Servers to retrieve pending Directive
void	sendTextRequest(int requestType, java.lang.String text, AsyncCallback<AvsResponse,java.lang.Exception> callback) Deprecated.
void	sendTextRequest(java.lang.String text, AsyncCallback<AvsResponse,java.lang.Exception> callback) Send a text string request to the AVS server, this is run through Text-To-Speech to create the raw audio file needed by the AVS server.
void	sendVolumeChangedEvent(long volume, boolean isMute, AsyncCallback<AvsResponse,java.lang.Exception> callback) Send a confirmation to the Alexa server that the device volume has been changed in response to a directive
void	startRecording(AsyncCallback<java.lang.Void,java.lang.Exception> callback) Deprecated.
void	startRecording(byte[] assetFile, AsyncCallback<java.lang.Void,java.lang.Exception> callback) Deprecated. - Deprecated because of the difficulty of managing Application state in an external library. Avoid using this and stopRecording(AsyncCallback), use sendAudioRequest(byte[], AsyncCallback) and manage state within your Application/Activity.
void	startRecording(int requestType, AsyncCallback<java.lang.Void,java.lang.Exception> callback) Deprecated.
void	startRecording(int requestType, byte[] assetFile, AsyncCallback<java.lang.Void,java.lang.Exception> callback) Deprecated.
void	startRecording(int requestType, java.lang.String assetFile, AsyncCallback<java.lang.Void,java.lang.Exception> callback) Deprecated.
void	startRecording(java.lang.String assetFile, AsyncCallback<java.lang.Void,java.lang.Exception> callback) Deprecated.
void	stopRecording(AsyncCallback<AvsResponse,java.lang.Exception> callback) Deprecated. - Deprecated because of the difficulty of managing Application state in an external library. Avoid using this and startRecording(AsyncCallback) (AsyncCallback)}, use sendAudioRequest(byte[], AsyncCallback) and manage state within your Application/Activity.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static AlexaManager getInstance(Context context,
                                       java.lang.String productId)

getSpeechSendVoice

public SpeechSendVoice getSpeechSendVoice()

getSpeechSendText

public SpeechSendText getSpeechSendText()

getSpeechSendAudio

public SpeechSendAudio getSpeechSendAudio()

getVoiceHelper

public VoiceHelper getVoiceHelper()

checkLoggedIn

public void checkLoggedIn(@NotNull
                          AsyncCallback<java.lang.Boolean,java.lang.Throwable> callback)

Check if the user is logged in to the Amazon service, uses an async callback with a boolean to return response

Parameters:

callback - state callback

logIn

public void logIn(@Nullable
                  AuthorizationCallback callback)

Send a log in request to the Amazon Authentication Manager

Parameters:

callback - state callback

sendOpenDownchannelDirective

public void sendOpenDownchannelDirective(@Nullable
                                         AsyncCallback<AvsResponse,java.lang.Exception> callback)

Send a get Directive request to the Alexa server to open a persistent connection

Parameters:

callback - state callback

sendSynchronizeStateEvent

public void sendSynchronizeStateEvent(@Nullable
                                      AsyncCallback<AvsResponse,java.lang.Exception> callback)

Send a synchronize state Event request to Alexa Servers to retrieve pending Directive

Parameters:

callback - state callback

isRecording

public boolean isRecording()

Helper function to check if we're currently recording

Returns:

startRecording

@Deprecated
public void startRecording(int requestType,
                                        @Nullable
                                        AsyncCallback<java.lang.Void,java.lang.Exception> callback)
                                 throws java.io.IOException

Deprecated.

Helper function to start our recording startRecording(int, byte[], AsyncCallback) * @deprecated - Deprecated because of the difficulty of managing Application state in an external library. Avoid using this and stopRecording(AsyncCallback), use sendAudioRequest(byte[], AsyncCallback) and manage state within your Application/Activity.

Throws:

java.io.IOException

startRecording

@Deprecated
public void startRecording(@Nullable
                                        AsyncCallback<java.lang.Void,java.lang.Exception> callback)

Deprecated.

Helper function to start our recording startRecording(int, byte[], AsyncCallback) * @deprecated - Deprecated because of the difficulty of managing Application state in an external library. Avoid using this and stopRecording(AsyncCallback), use sendAudioRequest(byte[], AsyncCallback) and manage state within your Application/Activity.

startRecording

@Deprecated
public void startRecording(int requestType,
                                        @Nullable
                                        java.lang.String assetFile,
                                        @Nullable
                                        AsyncCallback<java.lang.Void,java.lang.Exception> callback)
                                 throws java.io.IOException

Deprecated.

Helper function to start our recording startRecording(int, byte[], AsyncCallback) * @deprecated - Deprecated because of the difficulty of managing Application state in an external library. Avoid using this and stopRecording(AsyncCallback), use sendAudioRequest(byte[], AsyncCallback) and manage state within your Application/Activity.

Throws:

java.io.IOException

startRecording

@Deprecated
public void startRecording(@Nullable
                                        java.lang.String assetFile,
                                        @Nullable
                                        AsyncCallback<java.lang.Void,java.lang.Exception> callback)
                                 throws java.io.IOException

Deprecated.

Helper function to start our recording startRecording(int, byte[], AsyncCallback) * @deprecated - Deprecated because of the difficulty of managing Application state in an external library. Avoid using this and stopRecording(AsyncCallback), use sendAudioRequest(byte[], AsyncCallback) and manage state within your Application/Activity.

Throws:

java.io.IOException

startRecording

@Deprecated
public void startRecording(int requestType,
                                        @Nullable
                                        byte[] assetFile,
                                        @Nullable
                                        AsyncCallback<java.lang.Void,java.lang.Exception> callback)

Deprecated.

Helper function to start our recording startRecording(int, byte[], AsyncCallback) * @deprecated - Deprecated because of the difficulty of managing Application state in an external library. Avoid using this and stopRecording(AsyncCallback), use sendAudioRequest(byte[], AsyncCallback) and manage state within your Application/Activity.

startRecording

@Deprecated
public void startRecording(@Nullable
                                        byte[] assetFile,
                                        @Nullable
                                        AsyncCallback<java.lang.Void,java.lang.Exception> callback)

Deprecated. - Deprecated because of the difficulty of managing Application state in an external library. Avoid using this and stopRecording(AsyncCallback), use sendAudioRequest(byte[], AsyncCallback) and manage state within your Application/Activity.

Paired with stopRecording(AsyncCallback)--these need to be triggered manually or programmatically as a pair. This operation is done off the main thread and may need to be brought back to the main thread on callbacks. Check to see if the user is logged in, and if not, we request login, when they log in, or if they already are, we start recording audio to pass to the Amazon AVS server. This audio can be pre-pended by the byte[] assetFile, which needs to match the audio requirements of the rest of the service.

Parameters:

assetFile - our nullable byte[] that prepends audio to the record request

callback - our state callback

stopRecording

@Deprecated
public void stopRecording(@Nullable
                                       AsyncCallback<AvsResponse,java.lang.Exception> callback)

Deprecated. - Deprecated because of the difficulty of managing Application state in an external library. Avoid using this and startRecording(AsyncCallback) (AsyncCallback)}, use sendAudioRequest(byte[], AsyncCallback) and manage state within your Application/Activity.

Paired with startRecording()--these need to be triggered manually or programmatically as a pair. This operation is done off the main thread and may need to be brought back to the main thread on callbacks. Stop our current audio being recorded and send the post request off to the server. Warning: this does not check whether we're currently logged in. The world could explode if called without startRecording()

Parameters:

callback -

sendTextRequest

@Deprecated
public void sendTextRequest(int requestType,
                                         java.lang.String text,
                                         @Nullable
                                         AsyncCallback<AvsResponse,java.lang.Exception> callback)

Deprecated.

sendTextRequest

public void sendTextRequest(java.lang.String text,
                            @Nullable
                            AsyncCallback<AvsResponse,java.lang.Exception> callback)

Send a text string request to the AVS server, this is run through Text-To-Speech to create the raw audio file needed by the AVS server. This allows the developer to pre/post-pend or send any arbitrary text to the server, versus the startRecording()/stopRecording() combination which expects input from the user. This operation, because of the extra steps is generally slower than the above option.

Parameters:

text - the arbitrary text that we want to send to the AVS server

callback - the state change callback

sendAudioRequest

@Deprecated
public void sendAudioRequest(int requestType,
                                          byte[] data,
                                          AsyncCallback<AvsResponse,java.lang.Exception> callback)

Deprecated.

sendAudioRequest

public void sendAudioRequest(byte[] data,
                             @Nullable
                             AsyncCallback<AvsResponse,java.lang.Exception> callback)

Send raw audio data to the Alexa servers, this is a more advanced option to bypass other issues (like only one item being able to use the mic at a time).

Parameters:

data - the audio data that we want to send to the AVS server

callback - the state change callback

sendAudioRequest

public void sendAudioRequest(DataRequestBody requestBody,
                             @Nullable
                             AsyncCallback<AvsResponse,java.lang.Exception> callback)

Send streamed raw audio data to the Alexa servers, this is a more advanced option to bypass other issues (like only one item being able to use the mic at a time).

Parameters:

requestBody - a request body that incorporates either a static byte[] write to the BufferedSink or a streamed, managed byte[] data source

callback - the state change callback

sendVolumeChangedEvent

public void sendVolumeChangedEvent(long volume,
                                   boolean isMute,
                                   @Nullable
                                   AsyncCallback<AvsResponse,java.lang.Exception> callback)

Send a confirmation to the Alexa server that the device volume has been changed in response to a directive

Parameters:

volume - volume as reported by the AvsAdjustVolumeItem Directive

isMute - report whether the device is currently muted

callback - state callback

sendMutedEvent

public void sendMutedEvent(boolean isMute,
                           @Nullable
                           AsyncCallback<AvsResponse,java.lang.Exception> callback)

Send a confirmation to the Alexa server that the mute state has been changed in response to a directive

Parameters:

isMute - mute state as reported by the AvsSetMuteItem Directive

callback -

sendExpectSpeechTimeoutEvent

public void sendExpectSpeechTimeoutEvent(AsyncCallback<AvsResponse,java.lang.Exception> callback)

Send confirmation that the device has timed out without receiving a speech request when expected

Parameters:

callback -