TemplateRuntimeObserverInterface.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_CAPABILITYAGENTS_TEMPLATERUNTIME_TEMPLATERUNTIMEINTERFACES_INCLUDE_ACSDK_TEMPLATERUNTIMEINTERFACES_TEMPLATERUNTIMEOBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_CAPABILITYAGENTS_TEMPLATERUNTIME_TEMPLATERUNTIMEINTERFACES_INCLUDE_ACSDK_TEMPLATERUNTIMEINTERFACES_TEMPLATERUNTIMEOBSERVERINTERFACE_H_

#include <memory>
#include <string>

#include <AVSCommon/AVS/PlayerActivity.h>
#include <AVSCommon/SDKInterfaces/MediaPropertiesInterface.h>

namespace alexaClientSDK {
namespace templateRuntimeInterfaces {

class TemplateRuntimeObserverInterface {
public:
    struct AudioPlayerInfo {
        AudioPlayerInfo() : audioPlayerState{avsCommon::avs::PlayerActivity::IDLE} {};

        avsCommon::avs::PlayerActivity audioPlayerState;

        std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::MediaPropertiesInterface> mediaProperties;
    };

    virtual ~TemplateRuntimeObserverInterface() = default;

    virtual void renderTemplateCard(const std::string& jsonPayload) = 0;

    virtual void renderPlayerInfoCard(
        const std::string& jsonPayload,
        TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo) = 0;
};

}  // namespace templateRuntimeInterfaces
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPABILITYAGENTS_TEMPLATERUNTIME_TEMPLATERUNTIMEINTERFACES_INCLUDE_ACSDK_TEMPLATERUNTIMEINTERFACES_TEMPLATERUNTIMEOBSERVERINTERFACE_H_