AlexaClientSDK  1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Deprecated List
Member alexaClientSDK::acl::AVSConnectionManager::create (std::shared_ptr< MessageRouterInterface > messageRouter, bool isEnabled=true, std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface >> connectionStatusObservers=std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface >>(), std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface >> messageObservers=std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface >>(), std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface > internetConnectionMonitor=nullptr)
in release 1.21
Member alexaClientSDK::acl::HTTP2TransportFactory::HTTP2TransportFactory (std::shared_ptr< avsCommon::utils::http2::HTTP2ConnectionFactoryInterface > connectionFactory, std::shared_ptr< PostConnectFactoryInterface > postConnectFactory, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder=nullptr, std::shared_ptr< avsCommon::sdkInterfaces::EventTracerInterface > eventTracer=nullptr)
Member alexaClientSDK::acl::MessageRouter::MessageRouter (std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface > authDelegate, std::shared_ptr< avsCommon::avs::attachment::AttachmentManagerInterface > attachmentManager, std::shared_ptr< TransportFactoryInterface > transportFactory, const std::string &avsGateway="", int engineType=avsCommon::sdkInterfaces::ENGINE_TYPE_ALEXA_VOICE_SERVICES, std::chrono::milliseconds serverSideDisconnectGracePeriod=DEFAULT_SERVER_SIDE_DISCONNECT_GRACE_PERIOD)
Member alexaClientSDK::acl::PostConnectSequencerFactory::create (const std::vector< std::shared_ptr< PostConnectOperationProviderInterface >> &postConnectOperationProviders)
Member alexaClientSDK::acsdkAlerts::AlertsCapabilityAgent::create (std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > connectionManager, std::shared_ptr< certifiedSender::CertifiedSender > certifiedMessageSender, std::shared_ptr< avsCommon::sdkInterfaces::FocusManagerInterface > focusManager, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > speakerManager, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender, std::shared_ptr< storage::AlertStorageInterface > alertStorage, std::shared_ptr< avsCommon::sdkInterfaces::audio::AlertsAudioFactoryInterface > alertsAudioFactory, std::shared_ptr< renderer::RendererInterface > alertRenderer, std::shared_ptr< registrationManager::CustomerDataManager > dataManager, std::shared_ptr< settings::AlarmVolumeRampSetting > alarmVolumeRampSetting, std::shared_ptr< settings::DeviceSettingsManager > settingsManager, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder=nullptr, bool startAlertSchedulingOnInitialization=true, std::shared_ptr< avsCommon::utils::timing::SystemClockMonitor > systemClockMonitor=nullptr)
Member alexaClientSDK::acsdkAlerts::renderer::Renderer::create (std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > mediaPlayer, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder=nullptr)
Use createAlertRenderer.
Member alexaClientSDK::acsdkAlerts::storage::SQLiteAlertStorage::create (const avsCommon::utils::configuration::ConfigurationNode &configurationRoot, const std::shared_ptr< avsCommon::sdkInterfaces::audio::AlertsAudioFactoryInterface > &alertsAudioFactory)
Member alexaClientSDK::acsdkAudioPlayer::getBackwardsCompatibleComponent ()
This is for backwards compatibility only to allow the application to inject a PooledMediaResourceProviderInterface; prefer using getComponent.
Member alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerInterface::stopPlayback ()=0
Use LocalPlayerControlInterface.playbackStop instead
Member alexaClientSDK::acsdkEqualizer::MiscDBEqualizerStorage::create (std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > storage)
Use createEqualizerStorageInterface.
Member alexaClientSDK::acsdkEqualizer::SDKConfigEqualizerConfiguration::create (avsCommon::utils::configuration::ConfigurationNode &configRoot)
Member alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaPlayer::createExternalMediaPlayerWithAdapters (const acsdkExternalMediaPlayer::ExternalMediaPlayer::AdapterCreationMap &adapterCreationMap, std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface > audioPipelineFactory, std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< certifiedSender::CertifiedSender > certifiedMessageSender, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface > audioFocusManager, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionSender, std::shared_ptr< avsCommon::sdkInterfaces::PlaybackRouterInterface > playbackRouter, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface > endpointCapabilitiesRegistrar, std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > shutdownNotifier, std::shared_ptr< acsdkStartupManagerInterfaces::StartupNotifierInterface > startupNotifier, std::shared_ptr< avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderRegistrarInterface > renderPlayerInfoCardsProviderRegistrar, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > speakerManager)
This is for backwards compatibility only; prefer createExternalMediaPlayer which does not create adapters as part of EMP initialization, and instead adapters should register themselves with EMP.
Member alexaClientSDK::acsdkExternalMediaPlayer::getCreateExternalMediaPlayerWithAdapters (const acsdkExternalMediaPlayer::ExternalMediaPlayer::AdapterCreationMap &adapterCreationMap)
Applications should prefer to create components for their external media adapters; this is provided for backwards compatibility only.
Member alexaClientSDK::afml::interruptModel::InterruptModel::create (avsCommon::utils::configuration::ConfigurationNode interactionConfiguration)
Use createInterruptModel
Member alexaClientSDK::authorization::cblAuthDelegate::CBLAuthDelegate::create (const avsCommon::utils::configuration::ConfigurationNode &configuration, std::shared_ptr< registrationManager::CustomerDataManager > customerDataManager, std::shared_ptr< CBLAuthDelegateStorageInterface > storage, std::shared_ptr< CBLAuthRequesterInterface > authRequester, std::shared_ptr< avsCommon::utils::libcurlUtils::HttpPostInterface > httpPost=nullptr, std::shared_ptr< avsCommon::utils::DeviceInfo > deviceInfo=nullptr)
Member alexaClientSDK::authorization::cblAuthDelegate::SQLiteCBLAuthDelegateStorage::create (const avsCommon::utils::configuration::ConfigurationNode &configurationRoot)
Member alexaClientSDK::avsCommon::avs::attachment::AttachmentManager::AttachmentManager (AttachmentType attachmentType)
Member alexaClientSDK::avsCommon::avs::buildJsonEventString (const std::string &nameSpace, const std::string &eventName, const std::string &dialogRequestIdValue="", const std::string &jsonPayloadValue="{}", const std::string &jsonContext="")
This method is being deprecated in favor of the method with Endpoint information.
Member alexaClientSDK::avsCommon::avs::CapabilityConfiguration::CapabilityConfiguration (const std::unordered_map< std::string, std::string > &capabilityConfigurationIn)
This method will be removed soon.
Member alexaClientSDK::avsCommon::avs::ExceptionEncounteredSender::create (std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender)
Use createExceptionEncounteredSenderInterface instead.
Member alexaClientSDK::avsCommon::avs::initialization::AlexaClientSDKInit::getCreateAlexaClientSDKInit (const std::vector< std::shared_ptr< std::istream >> &jsonStreams)
v1.21.0. This method does not support some new features, such as low power mode. Get a function to create an instance of AlexaClientSDKInit.
Member alexaClientSDK::avsCommon::avs::initialization::AlexaClientSDKInit::initialize (const std::vector< std::shared_ptr< std::istream >> &jsonStreams)
v1.21.0 Initialize the Alexa Client SDK. This must be called before any Alexa Client SDK modules are created.
Class alexaClientSDK::avsCommon::avs::NamespaceAndName
This structure is being deprecated. From now on, use CapabilityTag instead.
Member alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface::setState (const avs::CapabilityTag &capabilityIdentifier, const std::string &jsonState, const avs::StateRefreshPolicy &refreshPolicy, const ContextRequestToken stateRequestToken=0)=0
Use the provideStateResponse for responding to provideState request and reportStateChange to proactively report to the ContextManager that the state has changed.
Member alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface::setStateProvider (const avs::CapabilityTag &capabilityIdentifier, std::shared_ptr< StateProviderInterface > stateProvider)=0
Use addStateProvider to add or replace the state provider and removeStateProvider to remove a state provider.
Member alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface::onContextAvailable (const std::string &jsonContext)
This method is being deprecated since it cannot specify the source endpoint.
Member alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface::onContextFailure (const ContextRequestError error)
This method is being deprecated since it cannot specify the optional token.
Member alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface::withModeController (std::shared_ptr< avsCommon::sdkInterfaces::modeController::ModeControllerInterface > modeController, const std::string &instance, const avsCommon::sdkInterfaces::modeController::ModeControllerAttributes &modeControllerAttributes, bool isProactivelyReported, bool isRetrievable, bool isNonControllable=false)=0
use the new withEndpointCapabilitiesBuilder() method instead.
Member alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface::withPowerController (std::shared_ptr< avsCommon::sdkInterfaces::powerController::PowerControllerInterface > powerController, bool isProactivelyReported, bool isRetrievable)=0
use the new withEndpointCapabilitiesBuilder() method instead.
Member alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface::withRangeController (std::shared_ptr< avsCommon::sdkInterfaces::rangeController::RangeControllerInterface > rangeController, const std::string &instance, const avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes &rangeControllerAttributes, bool isProactivelyReported, bool isRetrievable, bool isNonControllable=false)=0
use the new withEndpointCapabilitiesBuilder() method instead.
Member alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface::withToggleController (std::shared_ptr< avsCommon::sdkInterfaces::toggleController::ToggleControllerInterface > toggleController, const std::string &instance, const avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributes &toggleControllerAttributes, bool isProactivelyReported, bool isRetrievable, bool isNonControllable=false)=0
use the new withEndpointCapabilitiesBuilder() method instead.
Member alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface::withCapability (const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &configurationInterface, std::shared_ptr< DirectiveHandlerInterface > directiveHandler)=0
CapabilityConfigurationInterface is deprecated.
Member alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface::withCapabilityConfiguration (const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &configurationInterface)=0
CapabilityConfigurationInterface is deprecated.
Member alexaClientSDK::avsCommon::sdkInterfaces::SetStateResult
The setState operation has been deprecated and so is this enumeration.
Member alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerInterface::adjustVolume (ChannelVolumeInterface::Type type, int8_t delta, bool forceNoNotifications=false, SpeakerManagerObserverInterface::Source source=SpeakerManagerObserverInterface::Source::LOCAL_API)=0
Member alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerInterface::setMute (ChannelVolumeInterface::Type type, bool mute, bool forceNoNotifications=false, SpeakerManagerObserverInterface::Source source=SpeakerManagerObserverInterface::Source::LOCAL_API)=0
Member alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerInterface::setVolume (ChannelVolumeInterface::Type type, int8_t volume, bool forceNoNotifications=false, SpeakerManagerObserverInterface::Source source=SpeakerManagerObserverInterface::Source::LOCAL_API)=0
Member alexaClientSDK::avsCommon::sdkInterfaces::StateProviderInterface::provideState (const avs::NamespaceAndName &stateProviderName, const ContextRequestToken stateRequestToken)
NamespaceAndName is being deprecated. Use the CapabilityMessageIdentifier version instead.
Member alexaClientSDK::avsCommon::utils::DeviceInfo::create (const avsCommon::utils::configuration::ConfigurationNode &configurationRoot)
Member alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPost::create ()
Class alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerFactoryInterface
Use PooledMediaResourceProviderInterface instead.
Member alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface::getOffset (SourceId id)=0
Use getMediaPlayerState instead, which contains the offset
Member alexaClientSDK::avsCommon::utils::uuidGeneration::setSalt (const std::string &newSalt)
Member alexaClientSDK::avsGatewayManager::AVSGatewayManager::create (std::shared_ptr< storage::AVSGatewayManagerStorageInterface > avsGatewayManagerStorage, std::shared_ptr< registrationManager::CustomerDataManager > customerDataManager, const avsCommon::utils::configuration::ConfigurationNode &configurationRoot)
Member alexaClientSDK::capabilitiesDelegate::CapabilitiesDelegate::create (const std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface > &authDelegate, const std::shared_ptr< storage::CapabilitiesDelegateStorageInterface > &storage, const std::shared_ptr< registrationManager::CustomerDataManager > &customerDataManager)
Member alexaClientSDK::capabilitiesDelegate::storage::SQLiteCapabilitiesDelegateStorage::create (const avsCommon::utils::configuration::ConfigurationNode &configurationRoot)
Member alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceCapabilityAgent::create (const avsCommon::utils::DeviceInfo &deviceInfo, const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender, std::shared_ptr< AlexaInterfaceMessageSenderInternalInterface > alexaMessageSender)
Member alexaClientSDK::capabilityAgents::alexa::AlexaInterfaceMessageSender::create (std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender)
Use createAlexaInterfaceMessageSender.
Member alexaClientSDK::capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent::create (std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender, std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< settings::storage::DeviceSettingStorageInterface > settingsStorage)
Use createDoNotDisturbCapabilityAgent
Member alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter::create (std::shared_ptr< avsCommon::sdkInterfaces::PlaybackHandlerInterface > defaultHandler)
Use createPlaybackRouterInterface.
Member alexaClientSDK::contextManager::ContextManager::create (const avsCommon::utils::DeviceInfo &deviceInfo, std::shared_ptr< avsCommon::utils::timing::MultiTimer > multiTimer=std::make_shared< avsCommon::utils::timing::MultiTimer >(), std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder=nullptr)
Member alexaClientSDK::defaultClient::DefaultClient::addCaptionPresenter (std::shared_ptr< captions::CaptionPresenterInterface > presenter)
Applications should use the manufactory to create their CaptionPresenterInterface and inject it with the CaptionManagerInterface. See the SampleApplicationComponent for an example.
Member alexaClientSDK::defaultClient::DefaultClient::setCaptionMediaPlayers (const std::vector< std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >> &mediaPlayers)
Applications should use an ApplicationAudioPipelineFactoryInterface to instantiate media players and register them with the CaptionManager when they transition to the manufactory (e.g. see GstreamerAudioPipelineFactory).
Member alexaClientSDK::endpoints::EndpointBuilder::create (const avsCommon::utils::DeviceInfo &deviceInfo, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionSender, std::shared_ptr< capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface > alexaMessageSender)
Member alexaClientSDK::mediaPlayer::PooledMediaPlayerFactory::create (const std::vector< std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >> &pool, const avsCommon::utils::mediaPlayer::Fingerprint &fingerprint={})
Use adaptMediaPlayerFactoryInterface.
Member alexaClientSDK::sampleApp::ConsolePrinter::ConsolePrinter ()
(instances of ConsolePrinter needlessly duplicate ConsoleLogger functionality.)
Member alexaClientSDK::sampleApp::LocaleAssetsManager::create (bool enableWakeWord)
Member alexaClientSDK::sampleApp::SampleEqualizerModeController::create ()
Member alexaClientSDK::settings::SettingsManager< SettingsT >::SettingsManager (std::shared_ptr< registrationManager::CustomerDataManager > dataManager)
Member alexaClientSDK::settings::storage::SQLiteDeviceSettingStorage::create (const avsCommon::utils::configuration::ConfigurationNode &configurationRoot)
Use createDeviceSettingStorageInterface
Member alexaClientSDK::storage::sqliteStorage::SQLiteMiscStorage::create (const avsCommon::utils::configuration::ConfigurationNode &configurationRoot)
Member alexaClientSDK::synchronizeStateSender::SynchronizeStateSenderFactory::create (std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder=nullptr)
Member HTTPResponseCode
Use the alexaClientSDK::avsCommon::utils::http::HTTPResponseCode instead.

AlexaClientSDK 1.22.0 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0