Alexa Auto SDK  2.0.0
Classes | Public Member Functions | List of all members
com.amazon.aace.alexa.EqualizerController Class Referenceabstract

Classes

enum  EqualizerBand
 

Public Member Functions

void setBandLevels (EqualizerBandLevel[] bandLevels)
 
EqualizerBandLevel [] getBandLevels ()
 
final void localSetBandLevels (EqualizerBandLevel[] bandLevels)
 
final void localAdjustBandLevels (EqualizerBandLevel[] bandAdjustments)
 
final void localResetBands (EqualizerBand[] bands)
 
final void localResetBands ()
 

Detailed Description

EqualizerController should be extended to use Alexa to control device equalizer settings. It supports adjusting levels of amplitude gain in decibels (dB) for a 3-band equalizer with a 1dB level of precision.

In addition to performing the audio equalization, the platform implementation is also responsible for the following:

Device equalizer settings are configurable. See com.amazon.aace.alexa.config.AlexaConfiguration.createEqualizerControllerConfig for details on configuring supported bands, default state, and supported decibel ranges.

Member Function Documentation

◆ setBandLevels()

void com.amazon.aace.alexa.EqualizerController.setBandLevels ( EqualizerBandLevel []  bandLevels)

Notifies the platform implementation to apply the provided gain settings to the corresponding equalizer bands.

Note
Calling EqualizerController.localSetBandLevels, EqualizerController.localAdjustBandLevels, or EqualizerController.localResetBands from inside this function will cause deadlock.
Parameters
bandLevelsThe equalizer bands and their gain settings to apply as integer dB values.

◆ getBandLevels()

EqualizerBandLevel [] com.amazon.aace.alexa.EqualizerController.getBandLevels ( )

Retrieves the current equalizer gain settings on the device for each supported band. If unsupported band levels are provided, the Engine will truncate levels to the configured range.

Returns
An array of the supported equalizer bands and their current gain settings as integer dB values.

◆ localSetBandLevels()

final void com.amazon.aace.alexa.EqualizerController.localSetBandLevels ( EqualizerBandLevel []  bandLevels)

Notifies the Engine that gain levels for one or more equalizer bands are being set directly on the device. If unsupported levels are provided, the Engine will truncate the settings to the configured range.

Parameters
bandLevelsThe equalizer bands to change and their gain settings as integer dB values.

◆ localAdjustBandLevels()

final void com.amazon.aace.alexa.EqualizerController.localAdjustBandLevels ( EqualizerBandLevel []  bandAdjustments)

Notifies the Engine that relative adjustments to equalizer band gain levels are being made directly on the device. If adjustments put the band level settings beyond the configured dB range, the Engine will truncate the settings to the configured range.

Parameters
bandAdjustmentsThe equalizer bands to adjust and their relative gain adjustments as integer dB values.

◆ localResetBands() [1/2]

final void com.amazon.aace.alexa.EqualizerController.localResetBands ( EqualizerBand []  bands)

Notifies the Engine that the gain levels for the specified equalizer bands are being reset to their defaults.

Parameters
bandsThe equalizer bands to reset.

◆ localResetBands() [2/2]

final void com.amazon.aace.alexa.EqualizerController.localResetBands ( )

Notifies the Engine that the gain levels for all equalizer bands are being reset to their defaults.


Alexa Auto SDK 2.0.0 - Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0