playsync_manager_interface.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2019 SK Telecom Co., Ltd. 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.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 __NUGU_PLAYSYNC_MANAGER_INTERFACE_H__
#define __NUGU_PLAYSYNC_MANAGER_INTERFACE_H__
 
#include <map>
#include <string>
#include <vector>
 
#include <base/nugu_directive.h>
#include <nugu.h>
 
namespace NuguClientKit {
 
enum class PlaySyncState {
    None, 
    Prepared, 
    Synced, 
    Released, 
    Appending 
};
 
enum class PlayStackActivity {
    None, 
    Alert, 
    Call, 
    TTS, 
    Media 
};
 
class NUGU_API IPlaySyncManagerListener {
public:
    virtual ~IPlaySyncManagerListener() = default;
 
    virtual void onSyncState(const std::string& ps_id, PlaySyncState state, void* extra_data);
 
    virtual void onDataChanged(const std::string& ps_id, std::pair<void*, void*> extra_datas);
 
    virtual void onStackChanged(const std::pair<std::string, std::string>& ps_ids);
};
 
class NUGU_API IPlaySyncManager {
public:
    using PlaySyncContainer = std::map<std::string, std::pair<PlaySyncState, void*>>;
    using PlayStacks = std::map<std::string, PlaySyncContainer>;
 
public:
    virtual ~IPlaySyncManager() = default;
 
    virtual void registerCapabilityForSync(const std::string& capability_name) = 0;
 
    virtual void addListener(const std::string& requester, IPlaySyncManagerListener* listener) = 0;
 
    virtual void removeListener(const std::string& requester) = 0;
 
    virtual void prepareSync(const std::string& ps_id, NuguDirective* ndir) = 0;
 
    virtual void startSync(const std::string& ps_id, const std::string& requester, void* extra_data = nullptr) = 0;
 
    virtual void cancelSync(const std::string& ps_id, const std::string& requester) = 0;
 
    virtual void releaseSync(const std::string& ps_id, const std::string& requester) = 0;
 
    virtual void releaseSyncLater(const std::string& ps_id, const std::string& requester) = 0;
 
    virtual void releaseSyncImmediately(const std::string& ps_id, const std::string& requester) = 0;
 
    virtual void releaseSyncUnconditionally(const std::string& ps_id = "") = 0;
 
    virtual void postPoneRelease() = 0;
 
    virtual void continueRelease() = 0;
 
    virtual void stopHolding() = 0;
 
    virtual void resetHolding() = 0;
 
    virtual void clearHolding() = 0;
 
    virtual void restartHolding() = 0;
 
    virtual void clear() = 0;
 
    virtual bool isConditionToHandlePrevDialog(NuguDirective* prev_ndir, NuguDirective* cur_ndir) = 0;
 
    virtual bool hasActivity(const std::string& ps_id, PlayStackActivity activity) = 0;
 
    virtual bool hasNextPlayStack() = 0;
 
    virtual std::vector<std::string> getAllPlayStackItems() = 0;
 
    virtual void adjustPlayStackHoldTime(unsigned int time) = 0;
 
    virtual void setDefaultPlayStackHoldTime(unsigned int time) = 0;
 
    virtual void replacePlayStack(const std::string& prev_ps_id, const std::string& new_ps_id, std::pair<std::string, void*> extra_data = {}) = 0;
};
 
} // NuguClientKit
 
#endif /* __NUGU_PLAYSYNC_MANAGER_INTERFACE_H__ */