Skip to content

AlexaSpeaker

Outgoing Messages

SpeakerSettingsChanged

Notifies the platform implementation that the speaker settings have changed for a specific speaker type.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaSpeaker",
            "action": "SpeakerSettingsChanged"
        }
    },
    "payload": {
        "type": {{SpeakerType}},
        "local": {{Bool}},
        "volume": {{Int}},
        "mute": {{Bool}}        
    }
}

Payload

Property Type Required Description Example
type SpeakerType Yes The type of Alexa speaker being set.
local Bool Yes True if the change originated from calling localSetVolume().
volume Int Yes he new volume setting of the Speaker.
mute Bool Yes The mute setting of the Speaker.

Incoming Messages

LocalAdjustVolume

Notifies the Engine of a relative adjustment to the volume setting of the Speaker, originating on the platform. The delta value is relative to the current volume setting and is positive to increase volume or negative to reduce volume. The volume delta value should be scaled to fit the needs of the platform.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaSpeaker",
            "action": "LocalAdjustVolume"
        }
    },
    "payload": {
        "type": {{SpeakerType}},
        "delta": {{Int}}        
    }
}

Payload

Property Type Required Description Example
type SpeakerType Yes The type of Alexa speaker being set.
delta Int Yes The volume adjustment to apply to the Speaker.

LocalSetVolume

Notifies the Engine of a volume change event originating on the platform, such as a user pressing a "volume up" or "volume down" button. If the Speaker is AVS_SPEAKER_VOLUME, the Engine will respond with a call to setVolume() on each AVS-synced Speaker.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaSpeaker",
            "action": "LocalSetVolume"
        }
    },
    "payload": {
        "type": {{SpeakerType}},
        "volume": {{Int}}        
    }
}

Payload

Property Type Required Description Example
type SpeakerType Yes The type of Alexa speaker being set.
volume Int Yes The new volume setting of the Speaker.

LocalSetMute

Notifies the Engine of a mute setting change event originating on the platform, such as a user pressing a "mute" button. If the Speaker is AVS_SPEAKER_VOLUME, the Engine will respond with a call to setMute() on each AVS-synced Speaker.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaSpeaker",
            "action": "LocalSetMute"
        }
    },
    "payload": {
        "type": {{SpeakerType}},
        "mute": {{Bool}}        
    }
}

Payload

Property Type Required Description Example
type SpeakerType Yes The type of Alexa speaker being set.
mute Bool Yes The new mute setting of the Speaker.

Enums

SpeakerType

Values

Value Description
"ALEXA_VOLUME" The Speaker type that is controlled by AVS.
"ALERTS_VOLUME" The Speaker type that is controlled locally by the platform.
Back to top