alexaClientSDK::sampleApplications::common::EndpointFocusAdapter Class Reference

#include <EndpointFocusAdapter.h>

Inheritance diagram for alexaClientSDK::sampleApplications::common::EndpointFocusAdapter:

Collaboration diagram for alexaClientSDK::sampleApplications::common::EndpointFocusAdapter:

Public Types
using	FocusAcquiredCallback = std::function< void(void)>

Public Member Functions
virtual	~EndpointFocusAdapter ()=default
void	acquireFocus (const std::string &interfaceName, FocusAcquiredCallback callback)
ChannelObserverInterface Functions
void	onFocusChanged (avsCommon::avs::FocusState focusState, avsCommon::avs::MixingBehavior behavior) override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface
virtual	~ChannelObserverInterface ()=default

Static Public Member Functions
static std::shared_ptr< EndpointFocusAdapter >	create (std::shared_ptr< avsCommon::sdkInterfaces::FocusManagerInterface > focusManager, std::shared_ptr< presentationOrchestratorInterfaces::PresentationOrchestratorInterface > presentationOrchestrator, std::shared_ptr< presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface > presentationOrchestratorStateTracker)

Detailed Description

Class to handle focus management.

Member Typedef Documentation

FocusAcquiredCallback

using alexaClientSDK::sampleApplications::common::EndpointFocusAdapter::FocusAcquiredCallback = std::function<void(void)>

Constructor & Destructor Documentation

~EndpointFocusAdapter()

virtual alexaClientSDK::sampleApplications::common::EndpointFocusAdapter::~EndpointFocusAdapter ( )

virtualdefault

Destructor

Member Function Documentation

acquireFocus()

void alexaClientSDK::sampleApplications::common::EndpointFocusAdapter::acquireFocus	(	const std::string &	interfaceName,
		FocusAcquiredCallback	callback
	)

Acquire visual and audio focus.

Parameters

interfaceName	The interface requesting focus.
callback	The function to be invoked when focus is acquired.

create()

static std::shared_ptr<EndpointFocusAdapter> alexaClientSDK::sampleApplications::common::EndpointFocusAdapter::create ( std::shared_ptr< avsCommon::sdkInterfaces::FocusManagerInterface >  focusManager, std::shared_ptr< presentationOrchestratorInterfaces::PresentationOrchestratorInterface >  presentationOrchestrator, std::shared_ptr< presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface >  presentationOrchestratorStateTracker  )

static

Create an EndpointFocusAdapter object.

Parameters

focusManager	The FocusManager, to handle audio focus.
presentationOrchestrator	The PresentationOrchestrator, to dismiss any existing presentations.
presentationOrchestratorStateTracker	The PresentationOrchestratorStateTracker, to set and release the interface for visual focus.

Returns

A pointer to a new EndpointFocusAdapter object if it succeeds; otherwise, nullptr.

onFocusChanged()

void alexaClientSDK::sampleApplications::common::EndpointFocusAdapter::onFocusChanged ( avsCommon::avs::FocusState  newFocus, avsCommon::avs::MixingBehavior  behavior  )

overridevirtual

Used to notify the observer of the Channel of focus changes. Once called, the client should make a user observable change only and return immediately. Any additional work that needs to be done should be done on a separate thread or after returning. "User observable change" here refers to events that the end user of the product can visibly see or hear. For example, Alexa speech or music playing would be examples of user observable changes. Other work, such as database storing, logging, or communicating via network should be done on a different thread. Not doing so could result in delays for other clients trying to access the Channel.

Parameters

newFocus	The new Focus of the channel.
behavior	The mixingBehavior for the ChannelObserver to take as per the interrupt model

Note

when newFocus is FocusState::FOREGROUND, the MixingBehavior shall be guaranteed to be PRIMARY when newFocus is FocusState::NONE, the MixingBehavior shall be guaranteed to be MUST_STOP

Implements alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface.

---

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

• /workplace/avs-device-sdk/SampleApplications/Common/Endpoint/include/acsdk/Sample/Endpoint/EndpointFocusAdapter.h