AdapterUtils.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_ACSDKEXTERNALMEDIAPLAYERINTERFACES_INCLUDE_ACSDKEXTERNALMEDIAPLAYERINTERFACES_ADAPTERUTILS_H_
#define ALEXA_CLIENT_SDK_ACSDKEXTERNALMEDIAPLAYERINTERFACES_INCLUDE_ACSDKEXTERNALMEDIAPLAYERINTERFACES_ADAPTERUTILS_H_

#include <rapidjson/document.h>
#include <rapidjson/error/en.h>
#include <rapidjson/stringbuffer.h>
#include <rapidjson/writer.h>
#include <map>

#include <AVSCommon/AVS/NamespaceAndName.h>
#include <AVSCommon/Utils/RetryTimer.h>
#include "acsdkExternalMediaPlayerInterfaces/ExternalMediaAdapterInterface.h"

namespace alexaClientSDK {
namespace acsdkExternalMediaPlayerInterfaces {

enum class AdapterEvent {
    CHANGE_REPORT,

    REQUEST_TOKEN,

    LOGIN,

    LOGOUT,

    PLAYER_EVENT,

    PLAYER_ERROR_EVENT
};

inline std::string adapterEventToString(AdapterEvent event) {
    switch (event) {
        case AdapterEvent::CHANGE_REPORT:
            return "CHANGE_REPORT";
        case AdapterEvent::REQUEST_TOKEN:
            return "REQUEST_TOKEN";
        case AdapterEvent::LOGIN:
            return "LOGIN";
        case AdapterEvent::LOGOUT:
            return "LOGOUT";
        case AdapterEvent::PLAYER_EVENT:
            return "PLAYER_EVENT";
        case AdapterEvent::PLAYER_ERROR_EVENT:
            return "PLAYER_ERROR_EVENT";
    }
    // To satisfy errant compiler warnings, returning empty string
    return "";
}

inline std::ostream& operator<<(std::ostream& stream, const AdapterEvent& event) {
    return stream << adapterEventToString(event);
}

extern const std::vector<int> SESSION_RETRY_TABLE;

extern avsCommon::utils::RetryTimer SESSION_RETRY_TIMER;

// The NamespaceAndName for events sent from the adapter to AVS.
extern const avsCommon::avs::NamespaceAndName CHANGE_REPORT;
extern const avsCommon::avs::NamespaceAndName REQUEST_TOKEN;
extern const avsCommon::avs::NamespaceAndName LOGIN;
extern const avsCommon::avs::NamespaceAndName LOGOUT;
extern const avsCommon::avs::NamespaceAndName PLAYER_EVENT;
extern const avsCommon::avs::NamespaceAndName PLAYER_ERROR_EVENT;

// helper map for mapping adapter event type to its namespace and name
extern std::map<AdapterEvent, std::pair<std::string, std::string>> eventNameSpaceNameMap;

rapidjson::Value buildSupportedOperations(
    const std::set<acsdkExternalMediaPlayerInterfaces::SupportedPlaybackOperation>& supportedOperations,
    rapidjson::Document::AllocatorType& allocator);

bool buildMediaState(
    rapidjson::Value* document,
    const AdapterPlaybackState& playbackState,
    rapidjson::Document::AllocatorType& allocator);

rapidjson::Value buildPlaybackState(
    const acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState& playbackState,
    rapidjson::Document::AllocatorType& allocator);

rapidjson::Value buildSessionState(
    const acsdkExternalMediaPlayerInterfaces::AdapterSessionState& sessionState,
    rapidjson::Document::AllocatorType& allocator);

bool buildDefaultPlayerState(rapidjson::Value* document, rapidjson::Document::AllocatorType& allocator);

std::string getEmpContextString(acsdkExternalMediaPlayerInterfaces::AdapterState adapterState);

}  // namespace acsdkExternalMediaPlayerInterfaces
}  // namespace alexaClientSDK

#endif  // end
// ALEXA_CLIENT_SDK_ACSDKEXTERNALMEDIAPLAYERINTERFACES_INCLUDE_ACSDKEXTERNALMEDIAPLAYERINTERFACES_ADAPTERUTILS_H_