MediaPlayerFactoryInterface.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_MEDIAPLAYERFACTORYINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIAPLAYERFACTORYINTERFACE_H_

#include <memory>
#include <string>

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

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

// Forward-declare the MediaPlayerInterface class
class MediaPlayerInterface;

struct Fingerprint {
    std::string package;

    std::string buildType;

    std::string versionNumber;
};

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

    virtual Fingerprint getFingerprint() = 0;

    virtual std::shared_ptr<MediaPlayerInterface> acquireMediaPlayer() = 0;

    virtual bool releaseMediaPlayer(std::shared_ptr<MediaPlayerInterface> mediaPlayer) = 0;

    virtual bool isMediaPlayerAvailable() = 0;

    virtual void addObserver(std::shared_ptr<MediaPlayerFactoryObserverInterface> observer) = 0;

    virtual void removeObserver(std::shared_ptr<MediaPlayerFactoryObserverInterface> observer) = 0;
};

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIAPLAYERFACTORYINTERFACE_H_