EqualizerController

Outgoing Messages

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.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "EqualizerController",
            "action": "GetBandLevels"
        }
    }
}

SetBandLevels

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

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "EqualizerController",
            "action": "SetBandLevels"
        }
    },
    "payload": {
        "bandLevels": [{{EqualizerBandLevel}}]        
    }
}

Payload

Property	Type	Required	Description	Example
bandLevels	EqualizerBandLevel[]	Yes	The equalizer bands and their gain settings to apply as integer dB values.

Incoming Messages

LocalResetBands

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

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "EqualizerController",
            "action": "LocalResetBands"
        }
    },
    "payload": {
        "bands": [{{EqualizerBand}}]        
    }
}

Payload

Property	Type	Required	Description	Example
bands	EqualizerBand[]	No	The equalizer bands to reset. Empty @a bands resets all supported equalizer bands.

LocalSetBandLevels

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.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "EqualizerController",
            "action": "LocalSetBandLevels"
        }
    },
    "payload": {
        "bandLevels": [{{EqualizerBandLevel}}]        
    }
}

Payload

Property	Type	Required	Description	Example
bandLevels	EqualizerBandLevel[]	Yes	The equalizer bands to change and their gain settings as integer dB values.

LocalAdjustBandLevels

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.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "EqualizerController",
            "action": "LocalAdjustBandLevels"
        }
    },
    "payload": {
        "bandAdjustments": [{{EqualizerBandLevel}}]        
    }
}

Payload

Property	Type	Required	Description	Example
bandAdjustments	EqualizerBandLevel[]	Yes	he equalizer bands to adjust and their relative gain adjustments as integer dB values.

GetBandLevelsReply

Reply for GetBandLevels message.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "EqualizerController",
            "action": "GetBandLevels",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "bandLevels": [{{EqualizerBandLevel}}]        
    }
}

Payload

Property	Type	Required	Description	Example
bandLevels	EqualizerBandLevel[]	Yes	The supported equalizer bands and their current gain settings as integer dB values.

Type Definitions

EqualizerBandLevel

JSON Structure

{
    "band": {{EqualizerBand}},
    "level": {{Int}}        
}

Properties

Property	Type	Required	Description	Example
band	EqualizerBand	Yes	Describes the equalizer bands supported by Alexa. The platform implementation may support a subset of these.
level	Int	Yes	Describes the level of gain of a particular equalizer band as an integer dB value.

Enums

EqualizerBand

Values

Value	Description
"BASS"	Bass equalizer band.
"MIDRANGE"	Mid-range equalizer band.
"TREBLE"	Treble equalizer band.