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::FocusManagerObserverInterface Class Referenceabstract

An interface that clients can extend to register to observe focus changes. More...

#include <FocusManagerObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::FocusManagerObserverInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~FocusManagerObserverInterface ()=default
 
virtual void onFocusChanged (const std::string &channelName, avsCommon::avs::FocusState newFocus)=0
 

Detailed Description

An interface that clients can extend to register to observe focus changes.

Constructor & Destructor Documentation

◆ ~FocusManagerObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::FocusManagerObserverInterface::~FocusManagerObserverInterface ( )
virtualdefault

Member Function Documentation

◆ onFocusChanged()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::FocusManagerObserverInterface::onFocusChanged ( const std::string &  channelName,
avsCommon::avs::FocusState  newFocus 
)
pure virtual

Used to notify the observer of focus changes. This function should return quickly.

Parameters
channelNameThe name of the channel which changed FocusState.
newFocusThe new FocusState of channelName.

Implemented in alexaClientSDK::acsdkAlerts::AlertsCapabilityAgent.


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