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
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
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
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
Enums
SpeakerType
Values