AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::SpeakerInterface::SpeakerSettings Struct Reference

#include <SpeakerInterface.h>

Public Member Functions

bool operator== (const SpeakerSettings &rhs) const
 Operator overload to compare two SpeakerSettings objects. More...
 

Public Attributes

int8_t volume
 Must be within [AVS_SET_VOLUME_MIN, AVS_SET_VOLUME_MAX]. More...
 
bool mute
 True means muted, false means unmuted. More...
 

Detailed Description

This contains the current settings of the SpeakerInterface. The minimum volume level should correspond to no volume output, but this setting should still be independent from mute. For speakers which do not have independent mute and volume settings, the interface must be implemented as if they did so. For example, when unmuting a speaker, the volume setting should correspond to the level it was at before muting.

Member Function Documentation

◆ operator==()

bool alexaClientSDK::avsCommon::sdkInterfaces::SpeakerInterface::SpeakerSettings::operator== ( const SpeakerSettings rhs) const
inline

Operator overload to compare two SpeakerSettings objects.

Member Data Documentation

◆ mute

bool alexaClientSDK::avsCommon::sdkInterfaces::SpeakerInterface::SpeakerSettings::mute

True means muted, false means unmuted.

◆ volume

int8_t alexaClientSDK::avsCommon::sdkInterfaces::SpeakerInterface::SpeakerSettings::volume

Must be within [AVS_SET_VOLUME_MIN, AVS_SET_VOLUME_MAX].


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

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