MediaPlayerObserverInterface.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_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIAPLAYEROBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIAPLAYEROBSERVERINTERFACE_H_

#include <string>
#include <vector>
#include <memory>

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

#include "MediaPlayerInterface.h"
#include "MediaPlayerState.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {
namespace mediaPlayer {

class MediaPlayerObserverInterface {
public:
    using SourceId = MediaPlayerInterface::SourceId;

    enum class TagType { STRING, UINT, INT, DOUBLE, BOOLEAN };

    struct TagKeyValueType {
        std::string key;
        std::string value;
        MediaPlayerObserverInterface::TagType type;
    };

    typedef std::vector<TagKeyValueType> VectorOfTags;

    virtual ~MediaPlayerObserverInterface() = default;

    virtual void onFirstByteRead(SourceId id, const MediaPlayerState& state) = 0;

    virtual void onPlaybackStarted(SourceId id, const MediaPlayerState& state) = 0;

    virtual void onPlaybackFinished(SourceId id, const MediaPlayerState& state) = 0;

    virtual void onPlaybackError(
        SourceId id,
        const ErrorType& type,
        std::string error,
        const MediaPlayerState& state) = 0;

    virtual void onPlaybackPaused(SourceId, const MediaPlayerState&){};

    virtual void onPlaybackResumed(SourceId, const MediaPlayerState&){};

    virtual void onPlaybackStopped(SourceId, const MediaPlayerState&){};

    virtual void onBufferUnderrun(SourceId, const MediaPlayerState&) {
    }

    virtual void onBufferRefilled(SourceId, const MediaPlayerState&) {
    }

    virtual void onBufferingComplete(SourceId, const MediaPlayerState&) {
    }

    virtual void onSeeked(SourceId, const MediaPlayerState&, const MediaPlayerState&) {
    }

    virtual void onTags(SourceId, std::unique_ptr<const VectorOfTags>, const MediaPlayerState&){};
};

inline std::ostream& operator<<(std::ostream& stream, const MediaPlayerState& state) {
    stream << "MediaPlayerState: offsetInMilliseconds=" << state.offset.count();
    if (state.mediaPlayerProtection.hasValue()) {
        stream << "," << state.mediaPlayerProtection.value();
    }
    if (state.playlistType.hasValue()) {
        stream << "," << state.playlistType.value();
    }
    return stream;
}

}  // namespace mediaPlayer
}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIAPLAYEROBSERVERINTERFACE_H_