NotificationRendererInterface.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 ACSDKNOTIFICATIONSINTERFACES_NOTIFICATIONRENDERERINTERFACE_H_
#define ACSDKNOTIFICATIONSINTERFACES_NOTIFICATIONRENDERERINTERFACE_H_

#include <functional>
#include <iostream>
#include <memory>
#include <string>

#include <AVSCommon/Utils/MediaType.h>

#include "NotificationRendererObserverInterface.h"

namespace alexaClientSDK {
namespace acsdkNotificationsInterfaces {

class NotificationRendererInterface {
public:
    virtual ~NotificationRendererInterface() = default;

    virtual void addObserver(std::shared_ptr<NotificationRendererObserverInterface> observer) = 0;

    virtual void removeObserver(std::shared_ptr<NotificationRendererObserverInterface> observer) = 0;

    virtual bool renderNotification(
        std::function<std::pair<std::unique_ptr<std::istream>, const avsCommon::utils::MediaType>()> audioFactory,
        const std::string& url) = 0;

    virtual bool cancelNotificationRendering() = 0;
};

}  // namespace acsdkNotificationsInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKNOTIFICATIONSINTERFACES_NOTIFICATIONRENDERERINTERFACE_H_