CallStateObserverInterface.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_CALLSTATEOBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CALLSTATEOBSERVERINTERFACE_H_

#include <iostream>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class CallStateObserverInterface {
public:
    enum class CallState {
        CONNECTING,
        INBOUND_RINGING,
        CALL_CONNECTED,
        CALL_DISCONNECTED,
        NONE
    };

    typedef struct CallStateInfo {
        CallState callState;
        std::string callType;
        std::string previousSipUserAgentState;
        std::string currentSipUserAgentState;
        std::string displayName;
        std::string endpointLabel;
        std::string inboundCalleeName;
        std::string callProviderType;
        std::string callProviderImageUrl;
        std::string inboundRingtoneUrl;
        std::string outboundRingbackUrl;
        bool isDropIn;
    } CallStateInfo;

    virtual ~CallStateObserverInterface() = default;

    virtual void onCallStateChange(CallState state) = 0;

    virtual void onCallStateInfoChange(const CallStateInfo& stateInfo);

    static bool isStateActive(const CallStateObserverInterface::CallState& state);
};

inline std::ostream& operator<<(std::ostream& stream, const CallStateObserverInterface::CallState& state) {
    switch (state) {
        case CallStateObserverInterface::CallState::CONNECTING:
            stream << "CONNECTING";
            return stream;
        case CallStateObserverInterface::CallState::INBOUND_RINGING:
            stream << "INBOUND_RINGING";
            return stream;
        case CallStateObserverInterface::CallState::CALL_CONNECTED:
            stream << "CALL_CONNECTED";
            return stream;
        case CallStateObserverInterface::CallState::CALL_DISCONNECTED:
            stream << "CALL_DISCONNECTED";
            return stream;
        case CallStateObserverInterface::CallState::NONE:
            stream << "NONE";
            return stream;
    }
    return stream << "UNKNOWN STATE";
}

inline bool CallStateObserverInterface::isStateActive(const CallStateObserverInterface::CallState& state) {
    switch (state) {
        case CallStateObserverInterface::CallState::CONNECTING:
        case CallStateObserverInterface::CallState::INBOUND_RINGING:
        case CallStateObserverInterface::CallState::CALL_CONNECTED:
            return true;
        case CallStateObserverInterface::CallState::CALL_DISCONNECTED:
        case CallStateObserverInterface::CallState::NONE:
            return false;
    }
    return false;
}

inline void CallStateObserverInterface::onCallStateInfoChange(
    const CallStateObserverInterface::CallStateInfo& stateInfo) {
    return;
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_CALLSTATEOBSERVERINTERFACE_H_