MediaPlayerInterface.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_MEDIAPLAYERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIAPLAYERINTERFACE_H_

#include <chrono>
#include <cstdint>
#include <future>
#include <memory>

#include "AVSCommon/AVS/Attachment/AttachmentReader.h"
#include "AVSCommon/Utils/AudioFormat.h"
#include "AVSCommon/Utils/Optional.h"
#include "AVSCommon/Utils/MediaPlayer/MediaPlayerFactoryInterface.h"
#include "AVSCommon/Utils/MediaPlayer/MediaPlayerState.h"
#include "AVSCommon/Utils/MediaPlayer/PlaybackAttributes.h"
#include "AVSCommon/Utils/MediaPlayer/PlaybackContext.h"
#include "AVSCommon/Utils/MediaPlayer/PlaybackReport.h"
#include "AVSCommon/Utils/MediaPlayer/SourceConfig.h"
#include "AVSCommon/Utils/MediaType.h"
#include "AVSCommon/Utils/Optional.h"

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

static const std::chrono::milliseconds MEDIA_PLAYER_INVALID_OFFSET{-1};

class MediaPlayerObserverInterface;

class MediaPlayerInterface {
public:
    using SourceId = uint64_t;

    static const SourceId ERROR = 0;

    virtual ~MediaPlayerInterface() = default;

    virtual SourceId setSource(
        std::shared_ptr<avsCommon::avs::attachment::AttachmentReader> attachmentReader,
        const avsCommon::utils::AudioFormat* format = nullptr,
        const SourceConfig& config = emptySourceConfig()) = 0;

    virtual SourceId setSource(
        std::shared_ptr<avsCommon::avs::attachment::AttachmentReader> attachmentReader,
        std::chrono::milliseconds offsetAdjustment,
        const avsCommon::utils::AudioFormat* format = nullptr,
        const SourceConfig& config = emptySourceConfig()) = 0;

    virtual SourceId setSource(
        const std::string& url,
        std::chrono::milliseconds offset = std::chrono::milliseconds::zero(),
        const SourceConfig& config = emptySourceConfig(),
        bool repeat = false,
        const PlaybackContext& playbackContext = PlaybackContext()) = 0;

    virtual SourceId setSource(
        std::shared_ptr<std::istream> stream,
        bool repeat = false,
        const SourceConfig& config = emptySourceConfig(),
        avsCommon::utils::MediaType format = avsCommon::utils::MediaType::UNKNOWN) = 0;

    virtual bool play(SourceId id) = 0;

    virtual bool stop(SourceId id) = 0;

    virtual bool stop(SourceId id, std::chrono::seconds timeToPipelineShutdown) {
        return false;
    }

    virtual bool pause(SourceId id) = 0;

    virtual bool resume(SourceId id) = 0;

    virtual bool seekTo(SourceId id, std::chrono::milliseconds location, bool fromStart) {
        return false;
    }

    virtual std::chrono::milliseconds getOffset(SourceId id) = 0;

    virtual uint64_t getNumBytesBuffered() = 0;

    virtual utils::Optional<avsCommon::utils::mediaPlayer::MediaPlayerState> getMediaPlayerState(SourceId id) = 0;

    virtual void addObserver(
        std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface> playerObserver) = 0;

    virtual void removeObserver(
        std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface> playerObserver) = 0;

    virtual utils::Optional<PlaybackAttributes> getPlaybackAttributes();

    virtual std::vector<PlaybackReport> getPlaybackReports();

    virtual utils::Optional<Fingerprint> getFingerprint();
};

inline utils::Optional<PlaybackAttributes> MediaPlayerInterface::getPlaybackAttributes() {
    return utils::Optional<PlaybackAttributes>();
}

inline std::vector<PlaybackReport> MediaPlayerInterface::getPlaybackReports() {
    return {};
}

inline utils::Optional<Fingerprint> MediaPlayerInterface::getFingerprint() {
    return utils::Optional<Fingerprint>();
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIAPLAYERINTERFACE_H_