AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface Class Referenceabstract

#include <MRMHandlerInterface.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface:
Inheritance graph
Collaboration diagram for alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface:
Collaboration graph

Public Member Functions

 MRMHandlerInterface (const std::string &shutdownName)
virtual ~MRMHandlerInterface () override=default
virtual std::string getVersionString () const =0
virtual bool handleDirective (const std::string &nameSpace, const std::string &name, const std::string &messageId, const std::string &payload)=0
virtual void onUserInactivityReportSent ()=0
virtual void onCallStateChange (bool active)=0
virtual void onDialogUXStateChanged (avsCommon::sdkInterfaces::DialogUXStateObserverInterface::DialogUXState newState)=0
virtual void setObserver (std::shared_ptr< avsCommon::sdkInterfaces::RenderPlayerInfoCardsObserverInterface > observer)=0
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerObserverInterface
virtual void onSpeakerSettingsChanged (const Source &source, const ChannelVolumeInterface::Type &type, const SpeakerInterface::SpeakerSettings &settings)=0
virtual ~SpeakerManagerObserverInterface ()=default
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
 RequiresShutdown (const std::string &name)
virtual ~RequiresShutdown ()
 Destructor. More...
const std::string & name () const
void shutdown ()
bool isShutdown () const

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerObserverInterface
enum  Source { Source::DIRECTIVE, Source::LOCAL_API, Source::EXTERNAL_CLIENT }
 Indicates whether the source of the call is from an AVS Directive or through a Local API call. More...
- Protected Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
virtual void doShutdown ()=0

Detailed Description

An interface which should be extended by a class which wishes to implement lower level MRM functionality, such as device / platform, local network, time synchronization, and audio playback. The api provided here is minimal and sufficient with respect to integration with other AVS Client SDK components.

Constructor & Destructor Documentation

◆ MRMHandlerInterface()

alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface::MRMHandlerInterface ( const std::string &  shutdownName)


◆ ~MRMHandlerInterface()

virtual alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface::~MRMHandlerInterface ( )


Member Function Documentation

◆ getVersionString()

virtual std::string alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface::getVersionString ( ) const
pure virtual

Returns the string representation of the version of this MRM implementation.

The string representation of the version of this MRM implementation.

◆ handleDirective()

virtual bool alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface::handleDirective ( const std::string &  nameSpace,
const std::string &  name,
const std::string &  messageId,
const std::string &  payload 
pure virtual

Function to handle an MRM Directive.

nameSpaceThe namespace of the AVSDirective to be handled.
nameThe name of the AVSDirective to be handled.
messageIdThe messageId of the AVSDirective to be handled.
payloadThe payload of the AVSDirective to be handled.
Whether the Directive was handled successfully.

◆ onCallStateChange()

virtual void alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface::onCallStateChange ( bool  active)
pure virtual

Function to be called when a comms CallState has been changed.

◆ onDialogUXStateChanged()

virtual void alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface::onDialogUXStateChanged ( avsCommon::sdkInterfaces::DialogUXStateObserverInterface::DialogUXState  newState)
pure virtual

Function to be called when the DialogUXState has been changed.

◆ onUserInactivityReportSent()

virtual void alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface::onUserInactivityReportSent ( )
pure virtual

Function to be called when a System.UserInactivityReportSent Event has been sent to AVS.

Implemented in alexaClientSDK::capabilityAgents::mrm::test::MockMRMHandler.

◆ setObserver()

virtual void alexaClientSDK::capabilityAgents::mrm::MRMHandlerInterface::setObserver ( std::shared_ptr< avsCommon::sdkInterfaces::RenderPlayerInfoCardsObserverInterface observer)
pure virtual

Function to set the RenderPlayerInfoCardsProviderInterface.

observerThe RenderPlayerInfoCardsObserverInterface to be set.

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0