alexaClientSDK::afml::interruptModel::InterruptModel Class Reference

#include <InterruptModel.h>

Public Member Functions
avsCommon::avs::MixingBehavior	getMixingBehavior (const std::string &lowPriorityChannel, avsCommon::avs::ContentType lowPriorityContentType, const std::string &highPriorityChannel, avsCommon::avs::ContentType highPriorityContentType) const

Static Public Member Functions
static std::shared_ptr< InterruptModel >	createInterruptModel (const std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode > &config)
static std::shared_ptr< InterruptModel >	create (avsCommon::utils::configuration::ConfigurationNode interactionConfiguration)

Detailed Description

This class contains the interrupt model implementation for the device. This class uses the InterruptModelConfiguration passed in during creation to determine the MixingBehavior During Focus State transitions, the AFML shall invoke this class to determine the MixingBehavior to be taken by the ChannelObservers corresponding to the lower priority channel being backgrounded when a higher priority channel barges-in.

Member Function Documentation

create()

static std::shared_ptr<InterruptModel> alexaClientSDK::afml::interruptModel::InterruptModel::create ( avsCommon::utils::configuration::ConfigurationNode  interactionConfiguration )

static

Creates an instance of InterruptModel

Parameters

interactionConfiguration

interrupt model configuration for device.

Deprecated:

Use createInterruptModel

Returns

instance of InterruptModel.

createInterruptModel()

static std::shared_ptr<InterruptModel> alexaClientSDK::afml::interruptModel::InterruptModel::createInterruptModel ( const std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode > &  config )

static

Creates an instance of InterruptModel

Parameters

config

Root configuration node.

Returns

instance of InterruptModel.

getMixingBehavior()

avsCommon::avs::MixingBehavior alexaClientSDK::afml::interruptModel::InterruptModel::getMixingBehavior	(	const std::string &	lowPriorityChannel,
		avsCommon::avs::ContentType	lowPriorityContentType,
		const std::string &	highPriorityChannel,
		avsCommon::avs::ContentType	highPriorityContentType
	)		const

get Mixing Behavior for the lower priority channel

Parameters

lowPriorityChannel	the lower priority channel
lowPriorityContentType	the current content type
highPriorityChannel	the channel barging in
highPriorityContentType	the content type barging in

Returns

MixingBehavior which must be taken by the lower priority channel

---

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

• /workplace/avs-device-sdk/InterruptModel/include/InterruptModel/InterruptModel.h