focus_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_FOCUS_MANAGER_INTERFACE_H__
#define __NUGU_FOCUS_MANAGER_INTERFACE_H__
 
#include <iostream>
#include <vector>
 
#include <nugu.h>
 
namespace NuguClientKit {
 
#define CALL_FOCUS_TYPE "Call" 
#define CALL_FOCUS_REQUEST_PRIORITY 100 
#define CALL_FOCUS_RELEASE_PRIORITY 100 
#define ASR_USER_FOCUS_TYPE "ASRUser" 
#define ASR_USER_FOCUS_REQUEST_PRIORITY 100 
#define ASR_USER_FOCUS_RELEASE_PRIORITY 200 
#define ASR_DM_FOCUS_TYPE "ASRDM" 
#define ASR_DM_FOCUS_REQUEST_PRIORITY 400 
#define ASR_DM_FOCUS_RELEASE_PRIORITY 300 
#define INFO_FOCUS_TYPE "Info" 
#define INFO_FOCUS_REQUEST_PRIORITY 200 
#define INFO_FOCUS_RELEASE_PRIORITY 300 
#define ALERTS_FOCUS_TYPE "Alerts" 
#define ALERTS_FOCUS_REQUEST_PRIORITY 200 
#define ALERTS_FOCUS_RELEASE_PRIORITY 300 
#define ASR_BEEP_FOCUS_TYPE "ASRBeep" 
#define ASR_BEEP_FOCUS_REQUEST_PRIORITY 500 
#define ASR_BEEP_FOCUS_RELEASE_PRIORITY 400 
#define MEDIA_FOCUS_TYPE "Media" 
#define MEDIA_FOCUS_REQUEST_PRIORITY 300 
#define MEDIA_FOCUS_RELEASE_PRIORITY 500 
#define SOUND_FOCUS_TYPE "Sound" 
#define SOUND_FOCUS_REQUEST_PRIORITY 500 
#define SOUND_FOCUS_RELEASE_PRIORITY 500 
#define DUMMY_FOCUS_TYPE "Dummy" 
#define DUMMY_FOCUS_REQUEST_PRIORITY 600 
#define DUMMY_FOCUS_RELEASE_PRIORITY 500 
enum class FocusState {
    FOREGROUND, 
    BACKGROUND, 
    NONE 
};
 
typedef struct _FocusConfiguration {
    std::string type; 
    int priority; 
} FocusConfiguration;
 
class NUGU_API IFocusResourceListener {
public:
    virtual ~IFocusResourceListener() = default;
 
    virtual void onFocusChanged(FocusState state) = 0;
};
 
class NUGU_API IFocusManagerObserver {
public:
    virtual ~IFocusManagerObserver() = default;
 
    virtual void onFocusChanged(const FocusConfiguration& configuration, FocusState state, const std::string& name) = 0;
};
 
class NUGU_API IFocusManager {
public:
    virtual bool requestFocus(const std::string& type, const std::string& name, IFocusResourceListener* listener) = 0;
 
    virtual bool releaseFocus(const std::string& type, const std::string& name) = 0;
 
    virtual bool holdFocus(const std::string& type) = 0;
 
    virtual bool unholdFocus(const std::string& type) = 0;
 
    virtual void setConfigurations(std::vector<FocusConfiguration>& request, std::vector<FocusConfiguration>& release) = 0;
 
    virtual void stopAllFocus() = 0;
 
    virtual void stopForegroundFocus() = 0;
 
    virtual std::string getStateString(FocusState state) = 0;
 
    virtual FocusState convertToFocusState(const std::string& state_text) = 0;
 
    virtual void addObserver(IFocusManagerObserver* observer) = 0;
 
    virtual void removeObserver(IFocusManagerObserver* observer) = 0;
};
 
} // NuguClientKit
 
#endif /* __NUGU_FOCUS_MANAGER_INTERFACE_H__ */