AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
TemplateRuntimeObserverInterface.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_TEMPLATERUNTIMEOBSERVERINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_TEMPLATERUNTIMEOBSERVERINTERFACE_H_
18 
19 #include <chrono>
20 #include <string>
21 
24 
25 namespace alexaClientSDK {
26 namespace avsCommon {
27 namespace sdkInterfaces {
28 
35 public:
40  struct AudioPlayerInfo {
46  offset{std::chrono::milliseconds::zero()} {};
47 
54 
59  std::chrono::milliseconds offset;
60  };
61 
65  virtual ~TemplateRuntimeObserverInterface() = default;
66 
77  virtual void renderTemplateCard(const std::string& jsonPayload, avsCommon::avs::FocusState focusState) = 0;
78 
83  virtual void clearTemplateCard() = 0;
84 
94  virtual void renderPlayerInfoCard(
95  const std::string& jsonPayload,
97  avsCommon::avs::FocusState focusState) = 0;
98 
103  virtual void clearPlayerInfoCard() = 0;
104 };
105 
106 } // namespace sdkInterfaces
107 } // namespace avsCommon
108 } // namespace alexaClientSDK
109 
110 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_TEMPLATERUNTIMEOBSERVERINTERFACE_H_
virtual void renderPlayerInfoCard(const std::string &jsonPayload, TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo, avsCommon::avs::FocusState focusState)=0
avsCommon::avs::PlayerActivity audioPlayerState
Definition: TemplateRuntimeObserverInterface.h:46
Initial state, prior to acting on the first Play directive.
FocusState
Definition: FocusState.h:29
virtual void renderTemplateCard(const std::string &jsonPayload, avsCommon::avs::FocusState focusState)=0
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
PlayerActivity
Identifies the player state.
Definition: PlayerActivity.h:27
std::chrono::milliseconds offset
Definition: TemplateRuntimeObserverInterface.h:59

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0