AlexaClientSDK  1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Functions
alexaClientSDK Namespace Reference

Whether or not curl logs should be emitted. More...

Namespaces

 acl
 
 acsdkAlerts
 
 acsdkAlertsInterfaces
 
 acsdkAlexaCommunications
 
 acsdkAlexaEventProcessedNotifierInterfaces
 
 acsdkAndroidApplicationAudioPipelineFactory
 
 acsdkApplicationAudioPipelineFactoryInterfaces
 
 acsdkAudioPlayer
 
 acsdkAudioPlayerInterfaces
 
 acsdkAuthorizationDelegate
 
 acsdkBluetooth
 
 acsdkBluetoothInterfaces
 
 acsdkCore
 
 acsdkCustomApplicationAudioPipelineFactory
 
 acsdkDefaultSampleApplicationOptions
 
 acsdkDeviceSettingsManager
 
 acsdkDoNotDisturb
 
 acsdkEqualizer
 
 acsdkEqualizerInterfaces
 
 acsdkExternalMediaPlayer
 
 acsdkExternalMediaPlayerInterfaces
 
 acsdkGstreamerApplicationAudioPipelineFactory
 
 acsdkHTTPContentFetcher
 
 acsdkInternetConnectionMonitor
 
 acsdkManufactory
 
 acsdkMetricRecorder
 
 acsdkNotifications
 
 acsdkNotificationsInterfaces
 
 acsdkNotifier
 
 acsdkNotifierInterfaces
 
 acsdkPostConnectOperationProviderRegistrar
 
 acsdkPostConnectOperationProviderRegistrarInterfaces
 
 acsdkPreviewAlexaClient
 
 acsdkSampleApplication
 
 acsdkSampleApplicationCBLAuthRequester
 
 acsdkSampleApplicationInterfaces
 
 acsdkShared
 
 acsdkShutdownManager
 
 acsdkShutdownManagerInterfaces
 
 acsdkStartupManager
 
 acsdkStartupManagerInterfaces
 
 acsdkSystemTimeZone
 
 adsl
 
 afml
 
 applicationUtilities
 
 authorization
 
 avsCommon
 
 avsGatewayManager
 
 bluetoothImplementations
 
 capabilitiesDelegate
 
 capabilityAgents
 
 captions
 
 certifiedSender
 
 contextManager
 
 defaultClient
 
 diagnostics
 
 endpoints
 
 integration
 
 kwd
 
 mediaPlayer
 
 metrics
 
 playlistParser
 
 registrationManager
 
 sampleApp
 
 settings
 
 speechencoder
 
 storage
 
 synchronizeStateSender
 

Functions

std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterfacecreateApplicationAudioPipelineFactoryInterface (const std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface > &channelVolumeFactory, const std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > &speakerManager, const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface > &equalizerRuntimeSetup, const std::shared_ptr< avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > &httpContentFetcherFactory, const std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > &shutdownNotifier, const std::shared_ptr< applicationUtilities::androidUtilities::PlatformSpecificValues > &platformSpecificValues, const std::shared_ptr< captions::CaptionManagerInterface > &captionManager)
 
std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ApplicationMediaInterfacescreateCustomMediaPlayer (std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > contentFetcherFactory, bool enableEqualizer, const std::string &name, bool enableLiveMode)
 
std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterfacecreateApplicationAudioPipelineFactoryInterface (const std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface > &channelVolumeFactory, const std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > &speakerManager, const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface > &equalizerRuntimeSetup, const std::shared_ptr< avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > &httpContentFetcherFactory, const std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > &shutdownNotifier, const std::shared_ptr< captions::CaptionManagerInterface > &captionManager)
 

Detailed Description

Whether or not curl logs should be emitted.

Handle HTTP2 request / response for a ping sent to AVS.

Test of acsdkManufactory's compile time utilities.

Function Documentation

◆ createApplicationAudioPipelineFactoryInterface() [1/2]

std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface> alexaClientSDK::createApplicationAudioPipelineFactoryInterface ( const std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface > &  channelVolumeFactory,
const std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > &  speakerManager,
const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface > &  equalizerRuntimeSetup,
const std::shared_ptr< avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > &  httpContentFetcherFactory,
const std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > &  shutdownNotifier,
const std::shared_ptr< applicationUtilities::androidUtilities::PlatformSpecificValues > &  platformSpecificValues,
const std::shared_ptr< captions::CaptionManagerInterface > &  captionManager 
)
inline

Factory method to create a new instance of ApplicationAudioPipelineFactoryInterface.

Parameters
channelVolumeFactoryThe ChannelVolumeFactoryInterface to use for creating channel volume interfaces.
speakerManagerInterfaceThe SpeakerManagerInterface with which to register speakers.
equalizerRuntimeSetupThe EqualizerRuntimeSetupInterface with which to register equalizers.
httpContentFetcherFactoryThe HTTPContentFetcherInterfaceFactoryInterface to fetch remote http content.
shutdownNotifierThe ShutdownNotifierInterface to notify created media players of shutdown.
platformSpecificValuesThis object contains the Android-specific openSLES engine to use to create media players.
captionManagerThe CaptionManagerInterface to add captionable media sources.
Returns
A new ApplicationAudioPipelineFactoryInterface for Android media players.

◆ createApplicationAudioPipelineFactoryInterface() [2/2]

std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface > alexaClientSDK::createApplicationAudioPipelineFactoryInterface ( const std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface > &  channelVolumeFactory,
const std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > &  speakerManager,
const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface > &  equalizerRuntimeSetup,
const std::shared_ptr< avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface > &  httpContentFetcherFactory,
const std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > &  shutdownNotifier,
const std::shared_ptr< captions::CaptionManagerInterface > &  captionManager 
)
inline

Factory method to create a new instance of ApplicationAudioPipelineFactoryInterface.

Parameters
channelVolumeFactoryThe ChannelVolumeFactoryInterface to use for creating channel volume interfaces.
speakerManagerInterfaceThe SpeakerManagerInterface with which to register speakers.
equalizerRuntimeSetupThe EqualizerRuntimeSetup with which to register equalizers.
httpContentFetcherFactoryThe HTTPContentFetcherInterfaceFactoryInterface to fetch remote http content.
shutdownNotifierThe ShutdownNotifierInterface to notify created media players of shutdown.
captionManagerThe CaptionManagerInterface to add captionable media sources.
Returns
A new ApplicationAudioPipelineFactoryInterface for custom media players.

Factory method to create a new instance of ApplicationAudioPipelineFactoryInterface.

Parameters
channelVolumeFactoryThe ChannelVolumeFactoryInterface to use for creating channel volume interfaces.
speakerManagerInterfaceThe SpeakerManagerInterface with which to register speakers.
equalizerRuntimeSetupThe EqualizerRuntimeSetupInterface with which to register equalizers.
httpContentFetcherFactoryThe HTTPContentFetcherInterfaceFactoryInterface to fetch remote http content.
shutdownNotifierThe ShutdownNotifierInterface to notify created media players of shutdown.
captionManagerThe CaptionManagerInterface to add captionable media sources.
Returns
A new ApplicationAudioPipelineFactoryInterface for Gstreamer media players.

◆ createCustomMediaPlayer()

std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::ApplicationMediaInterfaces> alexaClientSDK::createCustomMediaPlayer ( std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface contentFetcherFactory,
bool  enableEqualizer,
const std::string &  name,
bool  enableLiveMode 
)

Custom media players must implement this function.

Parameters
contentFetcherFactoryUsed to create objects that can fetch remote HTTP content.
enableEqualizerFlag to indicate whether equalizer is enabled for this media player.
nameName of media player for logging purposes.
enableLiveModeFlag to indicate whether live mode is enabled for this media player.
Returns
Application Media interface if it succeeds; otherwise, return nullptr.

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