alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::AudioFocusManagerHandler Class Reference

#include <AudioFocusManagerHandler.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::AudioFocusManagerHandler:

Collaboration diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::AudioFocusManagerHandler:

Public Member Functions
void	processChannelResult (unsigned token, bool result)
void	processFocusChanged (unsigned token, avsCommon::avs::FocusState focusState)
void	registerHandlers ()
	Register this handler for its namespace and its methods for the corresponding namespace functions. More...
RequiresShutdown Functions
void	doShutdown () override
Public Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCHandlerBase
void	invokeMethod (const std::string &methodName, const std::string &message)
	~IPCHandlerBase ()
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

Static Public Member Functions
static std::shared_ptr< AudioFocusManagerHandler >	create (std::shared_ptr< IPCHandlerRegistrationInterface > ipcHandlerRegistrar, std::shared_ptr< AudioFocusManagerHandlerInterface > audioFocusManagerComponent)

Additional Inherited Members
Public Types inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCHandlerBase
using	IPCMessageHandler = std::function< void(const std::string &)>
	Alias for the message handler function. More...
Protected Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCHandlerBase
	IPCHandlerBase (const std::string &namespaceName, std::shared_ptr< alexaClientSDK::avsCommon::utils::threading::Executor > executor)
bool	registerIPCMessageHandlerMethod (const std::string &methodName, IPCMessageHandler handlerFunction)
bool	deregisterIPCMessageHandlerMethod (const std::string &methodName)
Protected Attributes inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCHandlerBase
std::string	m_namespaceName
	Name of the namespace of the realized IPC handler class. More...
std::unordered_map< std::string, IPCMessageHandler >	m_messageHandlers
	Dictionary to hold the IPC message handler methods. More...
std::shared_ptr< alexaClientSDK::avsCommon::utils::threading::Executor >	m_executor
	Executor context to support operations asynchronously. More...

Detailed Description

A contract for the handler that will handle the AudioFocusManager namespace messages coming from the IPC client.

Member Function Documentation

create()

static std::shared_ptr<AudioFocusManagerHandler> alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::AudioFocusManagerHandler::create ( std::shared_ptr< IPCHandlerRegistrationInterface >  ipcHandlerRegistrar, std::shared_ptr< AudioFocusManagerHandlerInterface >  audioFocusManagerComponent  )

static

Create an instance of AudioFocusManagerHandler

Parameters

ipcHandlerRegistrar	Used to register AudioFocusManagerHandler.
audioFocusManagerComponent	Handles the parsed AudioFocusManager payloads.

Returns

Shared pointer to AudioFocusManagerHandler

doShutdown()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::AudioFocusManagerHandler::doShutdown ( )

overridevirtual

Prepares/enables this object to be deleted. This should be the last function called on this object prior to deleting (or resetting) its shared_ptr.

Warning

• Attempting to call functions on this object after calling shutdown() can result in undefined behavior.
• Neglecting to call shutdown() on this object can result in resource leaks or other undefined behavior.

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

processChannelResult()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::AudioFocusManagerHandler::processChannelResult	(	unsigned	token,
		bool	result
	)

Sends a processChannelResult IPC message to the IPC client.

Parameters

token	Token identifying the requestor.
result	Result of channel focus acquisition or release request.

processFocusChanged()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::AudioFocusManagerHandler::processFocusChanged	(	unsigned	token,
		avsCommon::avs::FocusState	focusState
	)

Sends a processFocusChanged IPC message to the IPC client.

Parameters

token	Token identifying the requestor.
focusState	Enumerated focus state for the associated audio channel.

registerHandlers()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::AudioFocusManagerHandler::registerHandlers

(

)

Register this handler for its namespace and its methods for the corresponding namespace functions.

---

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

• /workplace/avs-device-sdk/SampleApplications/IPCServerSampleApplication/LibIPCServerSampleApp/include/IPCServerSampleApp/IPC/Components/AudioFocusManagerHandler.h