AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
alexaClientSDK::afml::FocusManager::ChannelConfiguration Class Reference

#include <FocusManager.h>

Public Member Functions

 ChannelConfiguration (const std::string &configName, unsigned int configPriority)
 
std::string toString () const
 

Static Public Member Functions

static bool readChannelConfiguration (const std::string &channelTypeKey, std::vector< afml::FocusManager::ChannelConfiguration > *virtualChannelConfigurations)
 

Public Attributes

std::string name
 The name of the channel. More...
 
unsigned int priority
 The priority of the channel. More...
 

Detailed Description

The configuration used by the FocusManager to create Channel objects. Each configuration object has a name and priority.

Constructor & Destructor Documentation

◆ ChannelConfiguration()

alexaClientSDK::afml::FocusManager::ChannelConfiguration::ChannelConfiguration ( const std::string &  configName,
unsigned int  configPriority 
)
inline

Constructor.

Parameters
configNameThe name of the Channel.
configPriorityThe priority of the channel. Lower number priorities result in higher priority Channels. The highest priority number possible is 0.

Member Function Documentation

◆ readChannelConfiguration()

bool alexaClientSDK::afml::FocusManager::ChannelConfiguration::readChannelConfiguration ( const std::string &  channelTypeKey,
std::vector< afml::FocusManager::ChannelConfiguration > *  virtualChannelConfigurations 
)
static

Get the virtual channel configurations.

Parameters
channelTypeKeyThe key of the virtual channel configuration to get.
[out]virtualChannelConfigurationThe ChannelConfiguration for the virtual channels as specified in channelTypeKey. An empty vector if there is no such info on the configuration file.
Returns
true if there's no error, false otherwise.

◆ toString()

std::string alexaClientSDK::afml::FocusManager::ChannelConfiguration::toString ( ) const
inline

Converts the config to a string.

Returns
A string version of the ChannelConfiguration data.

Member Data Documentation

◆ name

std::string alexaClientSDK::afml::FocusManager::ChannelConfiguration::name

The name of the channel.

◆ priority

unsigned int alexaClientSDK::afml::FocusManager::ChannelConfiguration::priority

The priority of the channel.


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

AlexaClientSDK 1.26.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0