CaptionManagerInterface.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_CAPTIONS_INTERFACE_INCLUDE_CAPTIONS_CAPTIONMANAGERINTERFACE_H_
#define ALEXA_CLIENT_SDK_CAPTIONS_INTERFACE_INCLUDE_CAPTIONS_CAPTIONMANAGERINTERFACE_H_

#include <memory>

#include "CaptionData.h"
#include "CaptionFrame.h"
#include "CaptionPresenterInterface.h"

namespace alexaClientSDK {
namespace captions {

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

    virtual void onCaption(CaptionFrame::MediaPlayerSourceId sourceId, const CaptionData& captionData) = 0;

    virtual void setCaptionPresenter(const std::shared_ptr<CaptionPresenterInterface>& presenter) = 0;

    virtual void setMediaPlayers(
        const std::vector<std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>>& mediaPlayers) = 0;

    virtual void addMediaPlayer(
        const std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>& mediaPlayer) = 0;

    virtual void removeMediaPlayer(
        const std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>& mediaPlayer) = 0;

    virtual bool isEnabled() const = 0;
};

}  // namespace captions
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPTIONS_INTERFACE_INCLUDE_CAPTIONS_CAPTIONMANAGERINTERFACE_H_