AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Static Public Member Functions | List of all members
alexaClientSDK::sampleApp::SDKDiagnostics Class Reference

#include <SDKDiagnostics.h>

Inheritance diagram for alexaClientSDK::sampleApp::SDKDiagnostics:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::sampleApp::SDKDiagnostics:
Collaboration graph
[legend]

Public Member Functions

Overridden DiagnosticsInterface methods.
std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DevicePropertyAggregatorInterfacegetDevicePropertyAggregator () override
 
std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::ProtocolTracerInterfacegetProtocolTracer () 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::AudioInjectorInterfacegetAudioInjector () 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< SDKDiagnosticscreate ()
 

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()

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< 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< 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< 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 files:

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