AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
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< InterruptModelcreateInterruptModel (const std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode > &config)
static std::shared_ptr< InterruptModelcreate (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)

Creates an instance of InterruptModel

interactionConfigurationinterrupt model configuration for device.
Use createInterruptModel
instance of InterruptModel.

◆ createInterruptModel()

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

Creates an instance of InterruptModel

configRoot configuration node.
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

lowPriorityChannelthe lower priority channel
lowPriorityContentTypethe current content type
highPriorityChannelthe channel barging in
highPriorityContentTypethe content type barging in
MixingBehavior which must be taken by the lower priority channel

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