CaptionFrame.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_CAPTIONFRAME_H_
#define ALEXA_CLIENT_SDK_CAPTIONS_INTERFACE_INCLUDE_CAPTIONS_CAPTIONFRAME_H_

#include <chrono>
#include <iostream>
#include <vector>

#include <AVSCommon/Utils/MediaPlayer/MediaPlayerObserverInterface.h>

#include "CaptionLine.h"

namespace alexaClientSDK {
namespace captions {

class CaptionFrame {
public:
    using MediaPlayerSourceId = avsCommon::utils::mediaPlayer::MediaPlayerInterface::SourceId;

    static int getLineWrapLimit();

    CaptionFrame(
        MediaPlayerSourceId sourceId = 0,
        std::chrono::milliseconds duration = std::chrono::milliseconds(0),
        std::chrono::milliseconds delay = std::chrono::milliseconds(0),
        const std::vector<CaptionLine>& captionLines = {});

    std::chrono::milliseconds getDuration() const;

    std::chrono::milliseconds getDelay() const;

    MediaPlayerSourceId getSourceId() const;

    std::vector<CaptionLine> getCaptionLines() const;

    bool operator==(const CaptionFrame& rhs) const;

    bool operator!=(const CaptionFrame& rhs) const;

private:
    MediaPlayerSourceId m_id;

    std::chrono::milliseconds m_duration;

    std::chrono::milliseconds m_delay;

    std::vector<CaptionLine> m_captionLines;
};

std::ostream& operator<<(std::ostream& stream, const CaptionFrame& frame);

}  // namespace captions
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPTIONS_INTERFACE_INCLUDE_CAPTIONS_CAPTIONFRAME_H_