AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface Class Referenceabstract

#include <DiagnosticsInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~DiagnosticsInterface ()=default
 Destructor. More...
 
virtual std::shared_ptr< DevicePropertyAggregatorInterfacegetDevicePropertyAggregator ()=0
 
virtual std::shared_ptr< ProtocolTracerInterfacegetProtocolTracer ()=0
 
virtual void setDiagnosticDependencies (std::shared_ptr< DirectiveSequencerInterface > sequencer, std::shared_ptr< avs::attachment::AttachmentManagerInterface > attachmentManager, std::shared_ptr< AVSConnectionManagerInterface > avsConnectionManager)=0
 
virtual std::shared_ptr< AudioInjectorInterfacegetAudioInjector ()=0
 

Detailed Description

A DiagnosticsInterface which provides a suite of APIs to provide diagnostic insight into the SDK.

Constructor & Destructor Documentation

◆ ~DiagnosticsInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface::~DiagnosticsInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getAudioInjector()

virtual std::shared_ptr<AudioInjectorInterface> alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface::getAudioInjector ( )
pure virtual

An API to inject audio utterances into the SDK.

Returns
The AudioInjectorInterface. A nullptr will be return if unsupported.

Implemented in alexaClientSDK::sampleApp::SDKDiagnostics.

◆ getDevicePropertyAggregator()

virtual std::shared_ptr<DevicePropertyAggregatorInterface> alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface::getDevicePropertyAggregator ( )
pure virtual

An API to obtain state information about the SDK.

Returns
The DevicePropertyAggregatorInterface. A nullptr will be return if unsupported.

Implemented in alexaClientSDK::sampleApp::SDKDiagnostics.

◆ getProtocolTracer()

virtual std::shared_ptr<ProtocolTracerInterface> alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface::getProtocolTracer ( )
pure virtual

An API to capture and store Directives and Events.

Returns
The ProtocolTracerInterface. A nullptr will be return if unsupported.

Implemented in alexaClientSDK::sampleApp::SDKDiagnostics.

◆ setDiagnosticDependencies()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface::setDiagnosticDependencies ( std::shared_ptr< DirectiveSequencerInterface sequencer,
std::shared_ptr< avs::attachment::AttachmentManagerInterface attachmentManager,
std::shared_ptr< AVSConnectionManagerInterface avsConnectionManager 
)
pure virtual

An API to pass optional dependencies to the DiagnosticsInterface.

Parameters
sequencerAn instance of the DirectiveSequencerInterface.
attachmentManagerAn instance of the AttachmentManager.
avsConnectionManagerAn instance of the AVSConnectionManager.

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

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