chips_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_CHIPS_INTERFACE_H__
#define __NUGU_CHIPS_INTERFACE_H__
 
#include <clientkit/capability_interface.hh>
#include <nugu.h>
 
namespace NuguCapability {
 
using namespace NuguClientKit;
 
enum class ChipsTarget {
    DM, 
    LISTEN, 
    SPEAKING 
};
 
enum class ChipsType {
    NUDGE, 
    ACTION, 
    GENERAL 
};
 
typedef struct _ChipsInfo {
    struct Content {
        ChipsType type; 
        std::string text; 
        std::string token; 
    };
 
    std::string play_service_id; 
    ChipsTarget target; 
    std::vector<Content> contents; 
} ChipsInfo;
 
class NUGU_API IChipsListener : virtual public ICapabilityListener {
public:
    virtual ~IChipsListener() = default;
 
    virtual void onReceiveRender(const ChipsInfo& chips_info) = 0;
};
 
class NUGU_API IChipsHandler : virtual public ICapabilityInterface {
public:
    virtual ~IChipsHandler() = default;
 
    virtual void addListener(IChipsListener* listener) = 0;
 
    virtual void removeListener(IChipsListener* listener) = 0;
};
 
} // NuguCapability
 
#endif /* __NUGU_CHIPS_INTERFACE_H__ */