ExternalMediaAdapterHandlerInterface.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_ACSDKEXTERNALMEDIAPLAYERINTERFACES_INCLUDE_ACSDKEXTERNALMEDIAPLAYERINTERFACES_EXTERNALMEDIAADAPTERHANDLERINTERFACE_H_
#define ALEXA_CLIENT_SDK_ACSDKEXTERNALMEDIAPLAYERINTERFACES_INCLUDE_ACSDKEXTERNALMEDIAPLAYERINTERFACES_EXTERNALMEDIAADAPTERHANDLERINTERFACE_H_

#include <chrono>
#include <string>
#include <vector>

#include <AVSCommon/AVS/PlayRequestor.h>
#include <AVSCommon/Utils/RequiresShutdown.h>

#include "acsdkExternalMediaPlayerInterfaces/ExternalMediaAdapterInterface.h"
#include "acsdkExternalMediaPlayerInterfaces/ExternalMediaPlayerCommon.h"

namespace alexaClientSDK {
namespace acsdkExternalMediaPlayerInterfaces {

class ExternalMediaPlayerInterface;

class ExternalMediaAdapterHandlerInterface : public alexaClientSDK::avsCommon::utils::RequiresShutdown {
public:
    explicit ExternalMediaAdapterHandlerInterface(const std::string& name);

    virtual ~ExternalMediaAdapterHandlerInterface() = default;

    struct PlayParams {
        std::string localPlayerId;
        std::string playContextToken;
        int64_t index;
        std::chrono::milliseconds offset;
        std::string skillToken;
        std::string playbackSessionId;
        Navigation navigation;
        bool preload;
        alexaClientSDK::avsCommon::avs::PlayRequestor playRequestor;
        std::string playbackTarget;

        PlayParams(
            const std::string& localPlayerId,
            const std::string& playContextToken,
            int64_t index,
            std::chrono::milliseconds offset,
            const std::string& skillToken,
            const std::string& playbackSessionId,
            Navigation navigation,
            bool preload,
            const alexaClientSDK::avsCommon::avs::PlayRequestor& playRequestor,
            const std::string& playbackTarget) :
                localPlayerId{localPlayerId},
                playContextToken{playContextToken},
                index{index},
                offset{offset},
                skillToken{skillToken},
                playbackSessionId{playbackSessionId},
                navigation{navigation},
                preload{preload},
                playRequestor(playRequestor),
                playbackTarget{playbackTarget} {
        }
    };

    virtual std::vector<PlayerInfo> updatePlayerInfo(const std::vector<PlayerInfo>& playerList) = 0;

    virtual bool login(
        const std::string& localPlayerId,
        const std::string& accessToken,
        const std::string& userName,
        bool forceLogin,
        std::chrono::milliseconds tokenRefreshInterval) = 0;

    virtual bool logout(const std::string& localPlayerId) = 0;

    virtual bool play(const PlayParams& params) = 0;

    virtual bool playControl(
        const std::string& localPlayerId,
        acsdkExternalMediaPlayerInterfaces::RequestType requestType,
        const std::string& playbackTarget) = 0;

    virtual bool seek(const std::string& localPlayerId, std::chrono::milliseconds offset) = 0;

    virtual bool adjustSeek(const std::string& localPlayerId, std::chrono::milliseconds deltaOffset) = 0;

    virtual acsdkExternalMediaPlayerInterfaces::AdapterState getAdapterState(const std::string& localPlayerId) = 0;

    virtual std::vector<acsdkExternalMediaPlayerInterfaces::AdapterState> getAdapterStates() = 0;

    virtual std::chrono::milliseconds getOffset(const std::string& localPlayerId) = 0;

    virtual void setExternalMediaPlayer(const std::shared_ptr<ExternalMediaPlayerInterface> externalMediaPlayer) = 0;
};

inline ExternalMediaAdapterHandlerInterface::ExternalMediaAdapterHandlerInterface(const std::string& name) :
        alexaClientSDK::avsCommon::utils::RequiresShutdown{name} {
}

}  // namespace acsdkExternalMediaPlayerInterfaces
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ACSDKEXTERNALMEDIAPLAYERINTERFACES_INCLUDE_ACSDKEXTERNALMEDIAPLAYERINTERFACES_EXTERNALMEDIAADAPTERHANDLERINTERFACE_H_