AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkEqualizer::EqualizerBandMapperInterface Class Referenceabstract

#include <EqualizerBandMapperInterface.h>

Inheritance diagram for alexaClientSDK::acsdkEqualizer::EqualizerBandMapperInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~EqualizerBandMapperInterface ()=default
 
virtual void mapEqualizerBands (const acsdkEqualizerInterfaces::EqualizerBandLevelMap &bandLevelMap, std::function< void(int, int)> setBandCallback)=0
 

Constructor & Destructor Documentation

◆ ~EqualizerBandMapperInterface()

virtual alexaClientSDK::acsdkEqualizer::EqualizerBandMapperInterface::~EqualizerBandMapperInterface ( )
virtualdefault

Member Function Documentation

◆ mapEqualizerBands()

virtual void alexaClientSDK::acsdkEqualizer::EqualizerBandMapperInterface::mapEqualizerBands ( const acsdkEqualizerInterfaces::EqualizerBandLevelMap bandLevelMap,
std::function< void(int, int)>  setBandCallback 
)
pure virtual

Maps AVS band levels to the target equalizer bands. Number of target bands and mapping method are implementation specific. All supported bands should be defined. It is up to the implementation to decide what levels to use for missing bands.

Parameters
bandLevelMapMap of AVS bands and their levels.
setBandCallbackCallback receiving the target band index and the level to be applied. It is up to the user to set up implementation properly to be able to map index to the band. No particular order of indices is guaranteed. The signature of the callback is void callback(int bandIndex, int level);

Implemented in alexaClientSDK::acsdkEqualizer::EqualizerLinearBandMapper.


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

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