PresentationTypes.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_AVS_SHARED_PRESENTATIONORCHESTRATOR_PRESENTATIONORCHESTRATORINTERFACES_INCLUDE_ACSDK_PRESENTATIONORCHESTRATORINTERFACES_PRESENTATIONTYPES_H_
#define ALEXA_CLIENT_SDK_AVS_SHARED_PRESENTATIONORCHESTRATOR_PRESENTATIONORCHESTRATORINTERFACES_INCLUDE_ACSDK_PRESENTATIONORCHESTRATORINTERFACES_PRESENTATIONTYPES_H_

#include <chrono>
#include <ostream>
#include <string>

namespace alexaClientSDK {
namespace presentationOrchestratorInterfaces {
using PresentationRequestToken = uint64_t;

enum class PresentationLifespan {
    TRANSIENT,

    SHORT,

    LONG,

    PERMANENT
};

enum class PresentationState {
    FOREGROUND,

    FOREGROUND_UNFOCUSED,

    BACKGROUND,

    NONE,
};

inline std::string presentationStateToString(PresentationState state) {
    switch (state) {
        case PresentationState::FOREGROUND:
            return "FOREGROUND";
        case PresentationState::FOREGROUND_UNFOCUSED:
            return "FOREGROUND_UNFOCUSED";
        case PresentationState::BACKGROUND:
            return "BACKGROUND";
        case PresentationState::NONE:
            return "NONE";
    }
    return "Unknown State";
}

inline std::ostream& operator<<(std::ostream& stream, const PresentationState& state) {
    return stream << presentationStateToString(state);
}

inline std::string presentationLifespanToString(PresentationLifespan lifespan) {
    switch (lifespan) {
        case PresentationLifespan::TRANSIENT:
            return "TRANSIENT";
        case PresentationLifespan::SHORT:
            return "SHORT";
        case PresentationLifespan::LONG:
            return "LONG";
        case PresentationLifespan::PERMANENT:
            return "PERMANENT";
    }
    return "Unknown Lifespan";
}

inline std::ostream& operator<<(std::ostream& stream, const PresentationLifespan& lifespan) {
    return stream << presentationLifespanToString(lifespan);
}

struct PresentationOptions {
    std::chrono::milliseconds timeout;

    PresentationLifespan presentationLifespan;

    std::string interfaceName;

    std::string metadata;
};

}  // namespace presentationOrchestratorInterfaces
}  // namespace alexaClientSDK
#endif  // ALEXA_CLIENT_SDK_AVS_SHARED_PRESENTATIONORCHESTRATOR_PRESENTATIONORCHESTRATORINTERFACES_INCLUDE_ACSDK_PRESENTATIONORCHESTRATORINTERFACES_PRESENTATIONTYPES_H_