alexaClientSDK::sampleApp::SDKDiagnostics Class Reference

#include <SDKDiagnostics.h>

Inheritance diagram for alexaClientSDK::sampleApp::SDKDiagnostics:

Collaboration diagram for alexaClientSDK::sampleApp::SDKDiagnostics:

Public Member Functions
Overridden DiagnosticsInterface methods.
std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface >	getDevicePropertyAggregator () override
std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface >	getProtocolTracer () override
void	setDiagnosticDependencies (std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface > sequencer, std::shared_ptr< avsCommon::avs::attachment::AttachmentManagerInterface > attachmentManager, std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > connectionManager) override
std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::AudioInjectorInterface >	getAudioInjector () override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface
virtual	~DiagnosticsInterface ()=default
	Destructor. More...
virtual void	setDiagnosticDependencies (std::shared_ptr< DirectiveSequencerInterface > sequencer, std::shared_ptr< avs::attachment::AttachmentManagerInterface > attachmentManager, std::shared_ptr< AVSConnectionManagerInterface > avsConnectionManager)=0

Static Public Member Functions
static std::unique_ptr< SDKDiagnostics >	create ()

Detailed Description

An SDK implementation which implements the DiagnosticsInterface APIs. This class depends on the underlying Diagnostic API objects for thread-safety.

Member Function Documentation

create()

static std::unique_ptr<SDKDiagnostics> alexaClientSDK::sampleApp::SDKDiagnostics::create ( )

static

Creates the SDKDiagnostics object.

Returns

An instance of the SDKDiagnostics object or a nullptr.

getAudioInjector()

std::shared_ptr<avsCommon::sdkInterfaces::diagnostics::AudioInjectorInterface> alexaClientSDK::sampleApp::SDKDiagnostics::getAudioInjector ( )

overridevirtual

An API to inject audio utterances into the SDK.

Returns

The AudioInjectorInterface. A nullptr will be return if unsupported.

Implements alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface.

getDevicePropertyAggregator()

std::shared_ptr<avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterface> alexaClientSDK::sampleApp::SDKDiagnostics::getDevicePropertyAggregator ( )

overridevirtual

An API to obtain state information about the SDK.

Returns

The DevicePropertyAggregatorInterface. A nullptr will be return if unsupported.

Implements alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface.

getProtocolTracer()

std::shared_ptr<avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterface> alexaClientSDK::sampleApp::SDKDiagnostics::getProtocolTracer ( )

overridevirtual

An API to capture and store Directives and Events.

Returns

The ProtocolTracerInterface. A nullptr will be return if unsupported.

Implements alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface.

setDiagnosticDependencies()

void alexaClientSDK::sampleApp::SDKDiagnostics::setDiagnosticDependencies ( std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface >  sequencer, std::shared_ptr< avsCommon::avs::attachment::AttachmentManagerInterface >  attachmentManager, std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface >  connectionManager  )

override

---

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

• /workplace/avs-device-sdk/SampleApplications/Common/LibSampleApp/include/SampleApp/SDKDiagnostics.h