CallManagerInterface.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CALLMANAGERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CALLMANAGERINTERFACE_H_

#include <memory>
#include <string>

#include <AVSCommon/AVS/CapabilityAgent.h>
#include <AVSCommon/SDKInterfaces/AVSGatewayObserverInterface.h>
#include <AVSCommon/SDKInterfaces/CallStateObserverInterface.h>
#include <AVSCommon/SDKInterfaces/ConnectionStatusObserverInterface.h>
#include <AVSCommon/SDKInterfaces/SoftwareInfoSenderObserverInterface.h>
#include <AVSCommon/SDKInterfaces/ExceptionEncounteredSenderInterface.h>
#include "AVSCommon/Utils/RequiresShutdown.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class DtmfObserverInterface;
class CallManagerInterface
        : public utils::RequiresShutdown
        , public avsCommon::avs::CapabilityAgent
        , public avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
        , public avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface
        , public avsCommon::sdkInterfaces::AVSGatewayObserverInterface {
public:
    CallManagerInterface(
        const std::string& objectName,
        const std::string& avsNamespace,
        std::shared_ptr<sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender);

    enum class DTMFTone {
        DTMF_ZERO,
        DTMF_ONE,
        DTMF_TWO,
        DTMF_THREE,
        DTMF_FOUR,
        DTMF_FIVE,
        DTMF_SIX,
        DTMF_SEVEN,
        DTMF_EIGHT,
        DTMF_NINE,
        DTMF_STAR,
        DTMF_POUND
    };

    virtual ~CallManagerInterface() = default;

    virtual void addObserver(std::shared_ptr<avsCommon::sdkInterfaces::CallStateObserverInterface> observer) = 0;

    virtual void removeObserver(std::shared_ptr<avsCommon::sdkInterfaces::CallStateObserverInterface> observer) = 0;

    virtual void addDtmfObserver(std::shared_ptr<DtmfObserverInterface> observer);

    virtual void removeDtmfObserver(std::shared_ptr<DtmfObserverInterface> observer);

    virtual void acceptCall() = 0;

    virtual void sendDtmf(DTMFTone dtmfTone) = 0;

    virtual void stopCall() = 0;

    virtual void muteSelf() = 0;

    virtual void unmuteSelf() = 0;

    virtual void enableVideo();

    virtual void disableVideo();

    virtual bool isSelfMuted() const = 0;
};

inline CallManagerInterface::CallManagerInterface(
    const std::string& objectName,
    const std::string& avsNamespace,
    std::shared_ptr<sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender) :
        utils::RequiresShutdown{objectName},
        avsCommon::avs::CapabilityAgent{avsNamespace, exceptionEncounteredSender} {
}

inline void CallManagerInterface::enableVideo() {
    return;
}

inline void CallManagerInterface::disableVideo() {
    return;
}

inline void CallManagerInterface::addDtmfObserver(std::shared_ptr<DtmfObserverInterface> observer) {
    return;
}

inline void CallManagerInterface::removeDtmfObserver(std::shared_ptr<DtmfObserverInterface> observer) {
    return;
}

}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CALLMANAGERINTERFACE_H_