AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
SpeakerInterface.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEAKERINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEAKERINTERFACE_H_
18 
19 #include <ostream>
20 
21 namespace alexaClientSDK {
22 namespace avsCommon {
23 namespace sdkInterfaces {
24 
34 public:
42  struct SpeakerSettings {
44  int8_t volume;
46  bool mute;
48  bool operator==(const SpeakerSettings& rhs) const {
49  return volume == rhs.volume && mute == rhs.mute;
50  }
51  };
52 
61  virtual bool setVolume(int8_t volume) = 0;
62 
69  virtual bool setMute(bool mute) = 0;
70 
77  virtual bool getSpeakerSettings(SpeakerSettings* settings) = 0;
78 
82  virtual ~SpeakerInterface() = default;
83 };
84 } // namespace sdkInterfaces
85 } // namespace avsCommon
86 } // namespace alexaClientSDK
87 
88 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEAKERINTERFACE_H_
bool mute
True means muted, false means unmuted.
Definition: SpeakerInterface.h:46
bool operator==(const SpeakerSettings &rhs) const
Operator overload to compare two SpeakerSettings objects.
Definition: SpeakerInterface.h:48
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
int8_t volume
Must be within [AVS_SET_VOLUME_MIN, AVS_SET_VOLUME_MAX].
Definition: SpeakerInterface.h:44
virtual bool getSpeakerSettings(SpeakerSettings *settings)=0

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