RendererInterface.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 ACSDKALERTS_RENDERER_RENDERERINTERFACE_H_
#define ACSDKALERTS_RENDERER_RENDERERINTERFACE_H_

#include "acsdkAlerts/Renderer/RendererObserverInterface.h"

#include <chrono>
#include <functional>
#include <memory>
#include <string>
#include <vector>

#include <AVSCommon/Utils/MediaType.h>

namespace alexaClientSDK {
namespace acsdkAlerts {
namespace renderer {

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

    virtual void start(
        std::shared_ptr<acsdkAlerts::renderer::RendererObserverInterface> observer,
        std::function<std::pair<std::unique_ptr<std::istream>, const avsCommon::utils::MediaType>()> audioFactory,
        bool volumeRampEnabled,
        const std::vector<std::string>& urls = std::vector<std::string>(),
        int loopCount = 0,
        std::chrono::milliseconds loopPause = std::chrono::milliseconds{0},
        bool startWithPause = false) = 0;

    virtual void stop() = 0;
};

}  // namespace renderer
}  // namespace acsdkAlerts
}  // namespace alexaClientSDK

#endif  // ACSDKALERTS_RENDERER_RENDERERINTERFACE_H_