![]() |
AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
Classes | |
class | AplCreateRendererMessage |
class | AplViewhostMessage |
class | CallStateChangeMessage |
class | ClearCameraMessage |
class | ClearPlayerInfoCardMessage |
class | ClearRenderTemplateCardMessage |
class | ClearWindowMessage |
class | CompleteAuthorizationMessage |
class | ConfigureClientMessage |
class | InitClientMessage |
class | ProcessChannelResultMessage |
class | ProcessFocusChangedMessage |
class | RenderCameraMessage |
class | RenderCaptionsMessage |
class | RenderPlayerInfoMessage |
class | RenderTemplateMessage |
class | SetAlexaStateMessage |
class | SetAuthorizationStateMessage |
class | SetCameraStateMessage |
class | SetCaptionsStateMessage |
class | SetDoNotDisturbStateMessage |
class | SetLocalesMessage |
class | SetVisualCharacteristicsMessage |
Functions | |
static const int | IPC_MSG_VERSION_CAPTIONS (1) |
The namespace version for Captions. More... | |
static const int | IPC_MSG_VERSION_APL (1) |
The namespace version for APL. More... | |
static const int | IPC_MSG_VERSION_AUDIO_FOCUS_MANAGER (1) |
The namespace version for AudioFocusManager. More... | |
static const int | IPC_MSG_VERSION_COMMUNICATIONS (1) |
The namespace version for Communications. More... | |
static const int | IPC_MSG_VERSION_DO_NOT_DISTURB (1) |
The namespace version for Do Not Disturb. More... | |
static const int | IPC_MSG_VERSION_INTERACTION_MANAGER (1) |
The namespace version for Interaction Manager. More... | |
static const int | IPC_MSG_VERSION_LIVE_VIEW_CAMERA (1) |
The namespace version for LiveViewCamera. More... | |
static const int | IPC_MSG_VERSION_LOGGER (1) |
The namespace version for Logger. More... | |
static const int | IPC_MSG_VERSION_SESSION_SETUP (1) |
The namespace version for SessionSetup. More... | |
static const int | IPC_MSG_VERSION_SYSTEM (1) |
The namespace version for System. More... | |
static const int | IPC_MSG_VERSION_TEMPLATE_RUNTIME (1) |
The namespace version for TemplateRuntime. More... | |
static const int | IPC_MSG_VERSION_WINDOW_MANAGER (1) |
The namespace version for Window Manager. More... | |
Variables | |
static const char | IPC_MSG_NAMESPACE_CAPTIONS [] = "AlexaCaptions" |
The message namespace for Captions. More... | |
static const char | IPC_MSG_NAME_RENDER_CAPTIONS [] = "renderCaptions" |
The message name for renderCaptions. More... | |
static const char | IPC_MSG_NAME_SET_CAPTIONS_STATE [] = "setCaptionsState" |
The message name for setCaptionsState. More... | |
static const char | IPC_MSG_NAME_ENABLED_TAG [] = "enabled" |
The enabled json key in the message. More... | |
static const char | IPC_MSG_NAMESPACE_APL [] = "APLClient" |
The message namespace for APLClient. More... | |
static const char | IPC_MESSAGE_NAME_VIEWHOST_MESSAGE [] = "sendMessageToViewhost" |
The message name for sendMessageToViewhost. More... | |
static const char | IPC_MESSAGE_NAME_CREATE_RENDERER [] = "createRenderer" |
The message name for createRenderer. More... | |
static const char | IPC_MSG_NAMESPACE_AUDIO_FOCUS_MANAGER [] = "AudioFocusManager" |
The message namespace for AudioFocusManager. More... | |
static const char | IPC_MSG_NAME_PROCESS_CHANNEL_RESULT [] = "processChannelResult" |
The message name for processChannelResult. More... | |
static const char | IPC_MSG_RESULT_TAG [] = "result" |
The result json key in the message. More... | |
static const char | IPC_MSG_NAME_PROCESS_FOCUS_CHANGED [] = "processFocusChanged" |
The message name for processFocusChanged. More... | |
static const char | IPC_MSG_FOCUS_STATE_TAG [] = "focusState" |
The focusState json key in the message. More... | |
static const char | IPC_MSG_NAMESPACE_COMMUNICATIONS [] = "Communications" |
The message namespace for Comms. More... | |
static const char | IPC_MSG_CALL_STATE_TAG [] = "callState" |
The callState json key in the message. More... | |
static const char | IPC_MSG_NAME_CALL_STATE_CHANGE [] = "callStateChange" |
The message name for callStateChange. More... | |
static const char | IPC_MSG_CALL_TYPE_TAG [] = "callType" |
The callType json key in the message. More... | |
static const char | IPC_MSG_PREVIOUS_SIP_USER_AGENT_STATE_TAG [] = "previousSipUserAgentState" |
The previousSipUserAgentState json key in the message. More... | |
static const char | IPC_MSG_CURRENT_SIP_USER_AGENT_STATE_TAG [] = "currentSipUserAgentState" |
The currentSipUserAgentState json key in the message. More... | |
static const char | IPC_MSG_DISPLAY_NAME_TAG [] = "displayName" |
The displayName json key in the message. More... | |
static const char | IPC_MSG_END_POINT_LABEL_TAG [] = "endpointLabel" |
The endpointLabel json key in the message. More... | |
static const char | IPC_MSG_INBOUND_CALLEE_NAME_TAG [] = "inboundCalleeName" |
The inboundCalleeName json key in the message. More... | |
static const char | IPC_MSG_CALL_PROVIDER_TYPE_TAG [] = "callProviderType" |
The callProviderType json key in the message. More... | |
static const char | IPC_MSG_INBOUND_RINGTONE_URL_TAG [] = "inboundRingtoneUrl" |
The inboundRingtoneUrl json key in the message. More... | |
static const char | IPC_MSG_OUTBOUND_RINGBACK_URL_TAG [] = "outboundRingbackUrl" |
The outboundRingbackUrl json key in the message. More... | |
static const char | IPC_MSG_IS_DROP_IN_TAG [] = "isDropIn" |
The isDropIn json key in the message. More... | |
static const char | IPC_MSG_NAMESPACE_DO_NOT_DISTURB [] = "DoNotDisturb" |
The message namespace for Do Not Disturb. More... | |
static const char | IPC_MSG_NAME_SET_DND_SETTING_CHANGE [] = "setDoNotDisturbState" |
The message name for setDoNotDisturbState. More... | |
static const char | IPC_MSG_NAMESPACE_INTERACTION_MANAGER [] = "InteractionManager" |
The message namespace for Interaction Manager. More... | |
static const char | IPC_MSG_NAMESPACE_LIVE_VIEW_CAMERA [] = "LiveViewCamera" |
The message namespace for LiveViewCamera. More... | |
static const char | IPC_MSG_NAME_RENDER_CAMERA [] = "renderCamera" |
The message name for renderCamera. More... | |
static const char | IPC_MSG_NAME_SET_CAMERA_STATE [] = "setCameraState" |
The message name for setCameraState. More... | |
static const char | IPC_MSG_NAME_CLEAR_CAMERA [] = "clearCamera" |
The message name for clearCamera. More... | |
static const char | IPC_MSG_START_LIVE_VIEW_PAYLOAD_TAG [] = "startLiveViewPayload" |
The startLiveViewPayload key in RenderCamera message. More... | |
static const char | IPC_MSG_NAMESPACE_LOGGER [] = "Logger" |
The message namespace for Logger. More... | |
static const char | IPC_FRAMEWORK_VERSION [] = "1.0.0" |
The version for the IPC Framework. More... | |
static const char | IPC_MSG_NAMESPACE_SESSION_SETUP [] = "SessionSetup" |
The message namespace for SessionSetup. More... | |
static const char | IPC_MSG_NAME_INIT_CLIENT [] = "initializeClient" |
The message name for initializeClient. More... | |
static const char | IPC_MSG_NAME_CONFIGURE_CLIENT [] = "configureClient" |
The message name for configureClient. More... | |
static const char | IPC_MSG_IPC_VERSION_TAG [] = "ipcVersion" |
The IPC Framework version key in the message. More... | |
static const char | IPC_MSG_NAMESPACE_SYSTEM [] = "System" |
The namespace namespace for System. More... | |
static const char | IPC_MSG_NAME_COMPLETE_AUTH [] = "completeAuthorization" |
The message name for completeAuthorization. More... | |
static const char | IPC_MSG_NAME_SET_ALEXA_STATE [] = "setAlexaState" |
The message name for setAlexaState. More... | |
static const char | IPC_MSG_NAME_SET_AUTH_STATE [] = "setAuthorizationState" |
The message name for setAuthorizationState. More... | |
static const char | IPC_MSG_NAME_SET_LOCALES [] = "setLocales" |
The message name for setLocales. More... | |
static const char | IPC_MSG_LOCALES_TAG [] = "locales" |
The locales json key in the message. More... | |
static const char | IPC_MSG_AUTH_URL_TAG [] = "url" |
The auth url json key in the message. More... | |
static const char | IPC_MSG_AUTH_CODE_TAG [] = "code" |
The auth code json key in the message. More... | |
static const char | IPC_MSG_CLIENT_ID_TAG [] = "clientId" |
The clientId json key in the message. More... | |
static const char | IPC_MSG_NAMESPACE_TEMPLATE_RUNTIME [] = "TemplateRuntime" |
The message namespace for TemplateRuntime. More... | |
static const char | IPC_MSG_NAME_CLEAR_PLAYER_INFO_CARD [] = "clearPlayerInfoCard" |
The message name for clearPlayerInfoCard. More... | |
static const char | IPC_MSG_NAME_CLEAR_TEMPLATE_CARD [] = "clearTemplateCard" |
The message name for clearTemplateCard. More... | |
static const char | IPC_MSG_NAME_RENDER_PLAYER_INFO [] = "renderPlayerInfo" |
The message name for renderPlayerInfo. More... | |
static const char | IPC_MSG_AUDIO_PLAYER_STATE_TAG [] = "audioPlayerState" |
The audioPlayerState json key in the message. More... | |
static const char | IPC_MSG_AUDIO_OFFSET_TAG [] = "audioOffset" |
The audioOffset json key in the message. More... | |
static const char | IPC_MSG_NAME_RENDER_TEMPLATE [] = "renderTemplate" |
The message handler name for renderTemplate. More... | |
static const char | IPC_MSG_NAMESPACE_WINDOW_MANAGER [] = "WindowManager" |
The message namespace for Window Manager. More... | |
static const char | IPC_MSG_NAME_SET_VISUAL_CHARACTERISTICS [] = "setVisualCharacteristics" |
The message name for set visual characteristics. More... | |
static const char | IPC_MSG_NAME_CLEAR_WINDOW [] = "clearWindow" |
The message name for clearWindow. More... | |
static const char | IPC_MSG_DEVICE_DISPLAY_TAG [] = "deviceDisplay" |
The device display json key in visual characteristics message. More... | |
static const char | IPC_MSG_INTERACTION_MODES_TAG [] = "interactionModes" |
The interaction modes json key in visual characteristics message. More... | |
static const char | IPC_MSG_WINDOW_TEMPLATES_TAG [] = "windowTemplates" |
The window templates json key in visual characteristics message. More... | |
static const char | VISUAL_CHARACTERISTICS_CAPABILITY_CONFIG_DISPLAY_TAG [] = "display" |
The key in visual characteristics capability config for Device display characteristics. More... | |
static const char | VISUAL_CHARACTERISTICS_CAPABILITY_CONFIG_INTERACTION_MODES_TAG [] = "interactionModes" |
The key in visual characteristics capability config for interaction modes configuration. More... | |
static const char | VISUAL_CHARACTERISTICS_CAPABILITY_CONFIG_WINDOW_TEMPLATES_TAG [] = "templates" |
The key in visual characteristics capability config for window templates configuration. More... | |
|
static |
The namespace version for APL.
|
static |
The namespace version for AudioFocusManager.
|
static |
The namespace version for Captions.
|
static |
The namespace version for Communications.
|
static |
The namespace version for Do Not Disturb.
|
static |
The namespace version for Interaction Manager.
|
static |
The namespace version for LiveViewCamera.
|
static |
The namespace version for Logger.
|
static |
The namespace version for SessionSetup.
|
static |
The namespace version for System.
|
static |
The namespace version for TemplateRuntime.
|
static |
The namespace version for Window Manager.
|
static |
The version for the IPC Framework.
|
static |
The message name for createRenderer.
|
static |
The message name for sendMessageToViewhost.
|
static |
The audioOffset json key in the message.
|
static |
The audioPlayerState json key in the message.
|
static |
The auth code json key in the message.
|
static |
The auth url json key in the message.
|
static |
The callProviderType json key in the message.
|
static |
The callState json key in the message.
|
static |
The callType json key in the message.
|
static |
The clientId json key in the message.
|
static |
The currentSipUserAgentState json key in the message.
|
static |
The device display json key in visual characteristics message.
|
static |
The displayName json key in the message.
|
static |
The endpointLabel json key in the message.
|
static |
The focusState json key in the message.
|
static |
The inboundCalleeName json key in the message.
|
static |
The inboundRingtoneUrl json key in the message.
|
static |
The interaction modes json key in visual characteristics message.
|
static |
The IPC Framework version key in the message.
|
static |
The isDropIn json key in the message.
|
static |
The locales json key in the message.
|
static |
The message name for callStateChange.
|
static |
The message name for clearCamera.
|
static |
The message name for clearPlayerInfoCard.
|
static |
The message name for clearTemplateCard.
|
static |
The message name for clearWindow.
|
static |
The message name for completeAuthorization.
|
static |
The message name for configureClient.
|
static |
The enabled json key in the message.
|
static |
The message name for initializeClient.
|
static |
The message name for processChannelResult.
|
static |
The message name for processFocusChanged.
|
static |
The message name for renderCamera.
|
static |
The message name for renderCaptions.
|
static |
The message name for renderPlayerInfo.
|
static |
The message handler name for renderTemplate.
|
static |
The message name for setAlexaState.
|
static |
The message name for setAuthorizationState.
|
static |
The message name for setCameraState.
|
static |
The message name for setCaptionsState.
|
static |
The message name for setDoNotDisturbState.
|
static |
The message name for setLocales.
|
static |
The message name for set visual characteristics.
|
static |
The message namespace for APLClient.
|
static |
The message namespace for AudioFocusManager.
|
static |
The message namespace for Captions.
|
static |
The message namespace for Comms.
|
static |
The message namespace for Do Not Disturb.
|
static |
The message namespace for Interaction Manager.
Interaction Manager does not have messages from IPC Server, but should be registered as a namespace to handle events from the IPC Client
|
static |
The message namespace for LiveViewCamera.
|
static |
The message namespace for Logger.
Logger does not have messages from IPC Server, but should be registered as a namespace to handle events from the IPC Client
|
static |
The message namespace for SessionSetup.
|
static |
The namespace namespace for System.
|
static |
The message namespace for TemplateRuntime.
|
static |
The message namespace for Window Manager.
|
static |
The outboundRingbackUrl json key in the message.
|
static |
The previousSipUserAgentState json key in the message.
|
static |
The result json key in the message.
|
static |
The startLiveViewPayload key in RenderCamera message.
|
static |
The window templates json key in visual characteristics message.
|
static |
The key in visual characteristics capability config for Device display characteristics.
|
static |
The key in visual characteristics capability config for interaction modes configuration.
|
static |
The key in visual characteristics capability config for window templates configuration.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0