GUIServerInterface.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_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_GUI_GUISERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_GUI_GUISERVERINTERFACE_H_

#include <AIP/Initiator.h>
#include <AVSCommon/AVS/CapabilityAgent.h>
#include <AVSCommon/AVS/ContentType.h>
#include <AVSCommon/SDKInterfaces/AuthObserverInterface.h>
#ifdef ENABLE_COMMS
#include <AVSCommon/SDKInterfaces/CallManagerInterface.h>
#endif
#include <AVSCommon/SDKInterfaces/ChannelObserverInterface.h>
#include <AVSCommon/SDKInterfaces/GUIActivityEvent.h>
#include <acsdk/PresentationOrchestratorInterfaces/PresentationOrchestratorTypes.h>
#include <acsdk/VisualCharacteristicsInterfaces/VisualCharacteristicsInterface.h>

#include <APLClient/AplRenderingEvent.h>
#include "NavigationEvent.h"

namespace alexaClientSDK {
namespace sampleApplications {
namespace ipcServerSampleApp {
namespace gui {

class GUIServerInterface {
public:
    virtual void handleRecognizeSpeechRequest(capabilityAgents::aip::Initiator initiator, bool start) = 0;

    virtual void handleMicrophoneToggle() = 0;

    virtual void handlePlaybackPlay() = 0;

    virtual void handlePlaybackPause() = 0;

    virtual void handlePlaybackNext() = 0;

    virtual void handlePlaybackPrevious() = 0;

    virtual void handlePlaybackSeekTo(int offset) = 0;

    virtual void handlePlaybackSkipForward() = 0;

    virtual void handlePlaybackSkipBackward() = 0;

    virtual void handlePlaybackToggle(const std::string& name, bool checked) = 0;

    virtual bool handleFocusAcquireRequest(
        std::string avsInterface,
        std::string channelName,
        avsCommon::avs::ContentType contentType,
        std::shared_ptr<avsCommon::sdkInterfaces::ChannelObserverInterface> channelObserver) = 0;

    virtual bool handleFocusReleaseRequest(
        std::string avsInterface,
        std::string channelName,
        std::shared_ptr<avsCommon::sdkInterfaces::ChannelObserverInterface> channelObserver) = 0;

    virtual void handleGUIActivityEvent(
        avsCommon::sdkInterfaces::GUIActivityEvent event,
        const std::string& source = "") = 0;

    virtual void handleNavigationEvent(NavigationEvent event) = 0;

    virtual std::vector<visualCharacteristicsInterfaces::WindowTemplate> getWindowTemplates() = 0;

    virtual std::vector<visualCharacteristicsInterfaces::InteractionMode> getInteractionModes() = 0;

    virtual visualCharacteristicsInterfaces::DisplayCharacteristics getDisplayCharacteristics() = 0;

    virtual void setWindowInstances(
        const std::vector<presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance>& instances,
        const std::string& defaultWindowInstanceId,
        const std::string& audioPlaybackUIWindowId) = 0;

    virtual bool addWindowInstance(
        const presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance& instance) = 0;

    virtual bool removeWindowInstance(const std::string& windowInstanceId) = 0;

    virtual void updateWindowInstance(
        const presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance& instance) = 0;

    virtual bool setDefaultWindowInstance(const std::string& windowInstanceId) = 0;

    virtual bool serializeInteractionMode(
        const std::vector<visualCharacteristicsInterfaces::InteractionMode>& interactionModes,
        std::string& serializedJson) = 0;

    virtual bool serializeWindowTemplate(
        const std::vector<visualCharacteristicsInterfaces::WindowTemplate>& windowTemplates,
        std::string& serializedJson) = 0;

    virtual bool serializeDisplayCharacteristics(
        const visualCharacteristicsInterfaces::DisplayCharacteristics& display,
        std::string& serializedJson) = 0;

    virtual std::chrono::milliseconds getDeviceTimezoneOffset() = 0;

    virtual void onUserEvent() = 0;

    virtual void forceExit() = 0;

    virtual void acceptCall() = 0;

    virtual void stopCall() = 0;

    virtual void enableLocalVideo() = 0;

    virtual void disableLocalVideo() = 0;

#ifdef ENABLE_COMMS

    virtual void sendDtmf(avsCommon::sdkInterfaces::CallManagerInterface::DTMFTone dtmfTone) = 0;
#endif

    virtual void handleOnMessagingServerConnectionOpened() = 0;

    virtual void handleDocumentTerminated(const std::string& token, bool failed) = 0;

    virtual void handleLocaleChange() = 0;

    virtual void initClient() = 0;
};

}  // namespace gui
}  // namespace ipcServerSampleApp
}  // namespace sampleApplications
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_GUI_GUISERVERINTERFACE_H_