AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
CallManagerInterface.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_CALLMANAGERINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CALLMANAGERINTERFACE_H_
18 
19 #include <memory>
20 #include <string>
21 
29 
30 namespace alexaClientSDK {
31 namespace avsCommon {
32 namespace sdkInterfaces {
33 
34 class DtmfObserverInterface;
44 public:
54  const std::string& objectName,
55  const std::string& avsNamespace,
56  std::shared_ptr<sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender);
57 
59  enum class DTMFTone {
60  DTMF_ZERO,
61  DTMF_ONE,
62  DTMF_TWO,
63  DTMF_THREE,
64  DTMF_FOUR,
65  DTMF_FIVE,
66  DTMF_SIX,
67  DTMF_SEVEN,
68  DTMF_EIGHT,
69  DTMF_NINE,
70  DTMF_STAR,
72  };
73 
77  virtual ~CallManagerInterface() = default;
78 
84  virtual void addObserver(std::shared_ptr<avsCommon::sdkInterfaces::CallStateObserverInterface> observer) = 0;
85 
91  virtual void removeObserver(std::shared_ptr<avsCommon::sdkInterfaces::CallStateObserverInterface> observer) = 0;
92 
98  virtual void addDtmfObserver(std::shared_ptr<DtmfObserverInterface> observer);
99 
105  virtual void removeDtmfObserver(std::shared_ptr<DtmfObserverInterface> observer);
106 
110  virtual void acceptCall() = 0;
111 
117  virtual void sendDtmf(DTMFTone dtmfTone) = 0;
118 
122  virtual void stopCall() = 0;
123 
127  virtual void muteSelf() = 0;
128 
132  virtual void unmuteSelf() = 0;
133 
137  virtual void enableVideo();
138 
142  virtual void disableVideo();
143 
149  virtual bool isSelfMuted() const = 0;
150 };
151 
153  const std::string& objectName,
154  const std::string& avsNamespace,
155  std::shared_ptr<sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender) :
156  utils::RequiresShutdown{objectName},
157  avsCommon::avs::CapabilityAgent{avsNamespace, exceptionEncounteredSender} {
158 }
159 
161  return;
162 }
163 
165  return;
166 }
167 
168 inline void CallManagerInterface::addDtmfObserver(std::shared_ptr<DtmfObserverInterface> observer) {
169  return;
170 }
171 
172 inline void CallManagerInterface::removeDtmfObserver(std::shared_ptr<DtmfObserverInterface> observer) {
173  return;
174 }
175 
176 } // namespace sdkInterfaces
177 } // namespace avsCommon
178 } // namespace alexaClientSDK
179 
180 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CALLMANAGERINTERFACE_H_
Definition: CapabilityAgent.h:47
virtual void removeObserver(std::shared_ptr< avsCommon::sdkInterfaces::CallStateObserverInterface > observer)=0
RequiresShutdown(const std::string &name)
Definition: RequiresShutdown.cpp:120
Definition: ConnectionStatusObserverInterface.h:31
virtual void addDtmfObserver(std::shared_ptr< DtmfObserverInterface > observer)
Definition: CallManagerInterface.h:168
virtual void disableVideo()
Definition: CallManagerInterface.h:164
virtual void removeDtmfObserver(std::shared_ptr< DtmfObserverInterface > observer)
Definition: CallManagerInterface.h:172
DTMFTone
An enum used to define the characters that dtmf tone can be.
Definition: CallManagerInterface.h:59
CallManagerInterface(const std::string &objectName, const std::string &avsNamespace, std::shared_ptr< sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionEncounteredSender)
Definition: CallManagerInterface.h:152
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
virtual void enableVideo()
Definition: CallManagerInterface.h:160
virtual void addObserver(std::shared_ptr< avsCommon::sdkInterfaces::CallStateObserverInterface > observer)=0
Definition: SoftwareInfoSenderObserverInterface.h:51

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