#include <PreviewAlexaClient.h>

Public Member Functions
sampleApp::SampleAppReturnCode	run ()

	~PreviewAlexaClient ()
	Destructor which manages the `SampleApplication` shutdown sequence. More...

Static Public Member Functions
static std::unique_ptr< PreviewAlexaClient >	create (std::shared_ptr< alexaClientSDK::sampleApp::ConsoleReader > consoleReader, const std::vector< std::string > &configFiles, const std::string &logLevel="", std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface > diagnostics=nullptr)

Detailed Description

Class to manage the top-level components of the AVS Client Application.

This PreviewAlexaClient is provided as a preview of the ongoing manufactory work being integrated into the SDK. It provides identical functionality to the SampleApplication, but the source code is different.

This class and the components it uses are expected to change over the next several releases as the SDK team incrementally integrates the manufactory to the SDK.

Constructor & Destructor Documentation

◆ ~PreviewAlexaClient()

alexaClientSDK::acsdkPreviewAlexaClient::PreviewAlexaClient::~PreviewAlexaClient ( )

Destructor which manages the SampleApplication shutdown sequence.

Member Function Documentation

◆ create()

std::unique_ptr< PreviewAlexaClient > alexaClientSDK::acsdkPreviewAlexaClient::PreviewAlexaClient::create	(	std::shared_ptr< alexaClientSDK::sampleApp::ConsoleReader >	consoleReader,
		const std::vector< std::string > &	configFiles,
		const std::string &	logLevel = `""`,
		std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface >	diagnostics = `nullptr`
	)

static

Create a PreviewAlexaClient.

Parameters

consoleReader	The `ConsoleReader` to read inputs from console.
configFiles	The vector of configuration files.
logLevel	The level of logging to enable. If this parameter is an empty string, the SDK's default logging level will be used.
diagnostics	An optional `DiagnosticsInterface` object to provide diagnostics on the SDK.

Returns: A new PreviewAlexaClient, or nullptr if the operation failed.

◆ run()

SampleAppReturnCode alexaClientSDK::acsdkPreviewAlexaClient::PreviewAlexaClient::run ( )

Runs the application, blocking until the user asks the application to quit or a device reset is triggered.

Returns: Returns a SampleAppReturnCode.

The documentation for this class was generated from the following files:

/workplace/avs-device-sdk/applications/acsdkPreviewAlexaClient/include/acsdkPreviewAlexaClient/PreviewAlexaClient.h
/workplace/avs-device-sdk/applications/acsdkPreviewAlexaClient/src/PreviewAlexaClient.cpp