alexaClientSDK::sampleApplications::ipcServerSampleApp Namespace Reference

Namespaces
	communication
	extensions
	gui
	ipc
	liveViewController
	messages
	test

Classes
class	AplClientBridge
struct	AplClientBridgeParameter
class	APLDocumentSession
class	APLDocumentSessionManager
class	APLDocumentSessionManagerInterface
class	APLPayloadParser
class	APLRuntimeInterfaceImpl
class	APLRuntimePresentationAdapter
class	APLViewhostInterface
class	APLViewhostObserverInterface
class	CachingDownloadManager
class	ConfigValidator
class	ConnectionObserver
class	ConsolePrinter
class	DownloadMonitor
class	ExternalCapabilitiesBuilder
class	GUILogBridge
class	IPCAPLAgent
class	KeywordObserver
class	LocaleAssetsManager
class	PortAudioMicrophoneWrapper
	This acts as a wrapper around PortAudio, a cross-platform open-source audio I/O library. More...
class	RenderCaptionsInterface
class	RevokeAuthorizationObserver
class	SampleApplication
	Class to manage the top-level components of the AVS Client Application. More...
class	SampleEqualizerModeController
class	SmartScreenCaptionPresenter
class	SmartScreenCaptionStateManager
class	TelemetrySink
class	TimezoneHelper

Typedefs
using	APLViewhostInterfacePtr = std::shared_ptr< APLViewhostInterface >
using	APLViewhostObserverInterfacePtr = std::shared_ptr< APLViewhostObserverInterface >
using	SampleApplicationComponent = acsdkManufactory::Component< std::shared_ptr< avsCommon::avs::initialization::AlexaClientSDKInit >, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface >, std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode >, std::shared_ptr< avsCommon::utils::DeviceInfo >, std::shared_ptr< registrationManager::CustomerDataManagerInterface >, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >, std::shared_ptr< cryptoInterfaces::CryptoFactoryInterface >, std::shared_ptr< cryptoInterfaces::KeyStoreInterface > >
using	SampleApplicationOptionsComponent = acsdkManufactory::Component< acsdkManufactory::Import< std::unique_ptr< avsCommon::utils::libcurlUtils::HttpPostInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::utils::DeviceInfo > >, acsdkManufactory::Import< std::shared_ptr< registrationManager::CustomerDataManagerInterface > >, std::shared_ptr< avsCommon::utils::logger::Logger >, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > >

Enumerations
enum	IPCLogLevel {   IPCLogLevel::DEBUG5, IPCLogLevel::INFO, IPCLogLevel::WARN, ERROR,   IPCLogLevel::UNKNOWN }
enum	SampleAppReturnCode { OK = EXIT_SUCCESS, ERROR = EXIT_FAILURE, ERROR, RESTART }

Functions
std::string	cachedContentToString (CachingDownloadManager::CachedContent content, std::string delimiter)
IPCLogLevel	ipcLogLevelFromString (const std::string &logLevel)
SampleApplicationOptionsComponent	getSampleApplicationOptionsComponent ()
SampleApplicationComponent	getComponent (std::unique_ptr< avsCommon::avs::initialization::InitializationParameters > initParams, std::vector< std::shared_ptr< avsCommon::utils::RequiresShutdown >> &requiresShutdownList, const std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface > &authDelegate=nullptr, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &metricRecorder=nullptr, const std::shared_ptr< avsCommon::utils::logger::Logger > &logger=nullptr)

Typedef Documentation

APLViewhostInterfacePtr

using alexaClientSDK::sampleApplications::ipcServerSampleApp::APLViewhostInterfacePtr = typedef std::shared_ptr<APLViewhostInterface>

APLViewhostObserverInterfacePtr

using alexaClientSDK::sampleApplications::ipcServerSampleApp::APLViewhostObserverInterfacePtr = typedef std::shared_ptr<APLViewhostObserverInterface>

SampleApplicationComponent

using alexaClientSDK::sampleApplications::ipcServerSampleApp::SampleApplicationComponent = typedef acsdkManufactory::Component< std::shared_ptr<avsCommon::avs::initialization::AlexaClientSDKInit>, std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface>, std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>, std::shared_ptr<avsCommon::utils::DeviceInfo>, std::shared_ptr<registrationManager::CustomerDataManagerInterface>, std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>, std::shared_ptr<cryptoInterfaces::CryptoFactoryInterface>, std::shared_ptr<cryptoInterfaces::KeyStoreInterface> >

Definition of the Manufactory component for the Sample App.

SampleApplicationOptionsComponent

using alexaClientSDK::sampleApplications::ipcServerSampleApp::SampleApplicationOptionsComponent = typedef acsdkManufactory::Component< acsdkManufactory::Import<std::unique_ptr<avsCommon::utils::libcurlUtils::HttpPostInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::utils::DeviceInfo> >, acsdkManufactory::Import<std::shared_ptr<registrationManager::CustomerDataManagerInterface> >, std::shared_ptr<avsCommon::utils::logger::Logger>, std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> >

Enumeration Type Documentation

IPCLogLevel

enum alexaClientSDK::sampleApplications::ipcServerSampleApp::IPCLogLevel

strong

Enum used to specify the severity assigned to an IPC client log message.

Enumerator
DEBUG5	Intermediate debug log level.
INFO	Logs of normal operations, to be used in release builds.
WARN	Log of an event that may indicate a problem.
ERROR	Log of an event that indicates an error.
UNKNOWN	An unknown severity level.

SampleAppReturnCode

enum alexaClientSDK::sampleApplications::ipcServerSampleApp::SampleAppReturnCode

Enumerator
OK	The SampleApp exits in success.
ERROR	The SampleApp exits in failure.
ERROR	Log of an event that indicates an error.
RESTART	The SampleApp exits and needs a restart.

Function Documentation

cachedContentToString()

std::string alexaClientSDK::sampleApplications::ipcServerSampleApp::cachedContentToString ( CachingDownloadManager::CachedContent  content, std::string  delimiter  )

inline

This is a function to convert the CachedContent to a string.

getComponent()

SampleApplicationComponent alexaClientSDK::sampleApplications::ipcServerSampleApp::getComponent	(	std::unique_ptr< avsCommon::avs::initialization::InitializationParameters >	initParams,
		std::vector< std::shared_ptr< avsCommon::utils::RequiresShutdown >> &	requiresShutdownList,
		const std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface > &	authDelegate = nullptr,
		const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &	metricRecorder = nullptr,
		const std::shared_ptr< avsCommon::utils::logger::Logger > &	logger = nullptr
	)

Get the manufactory Component for SampleApp.

Returns

The manufactory Component for SampleApp.

getSampleApplicationOptionsComponent()

SampleApplicationOptionsComponent alexaClientSDK::sampleApplications::ipcServerSampleApp::getSampleApplicationOptionsComponent

(

)

Get the Manufactory Component for the default SampleApplication options

Returns

The Manufactory Component for the default SampleApplication options

ipcLogLevelFromString()

IPCLogLevel alexaClientSDK::sampleApplications::ipcServerSampleApp::ipcLogLevelFromString ( const std::string &  logLevel )

inline

Convert a string into a IPCLogLevel value.

Parameters

logLevel

The std::string value to convert to a IPCLogLevel value.

Returns

The IPCLogLevel conversion of the std::string value.