#include <PresentationInterface.h>
Interface which represents a Presentation object, provides methods to manage the lifecycle of a presentation
◆ ~PresentationInterface()
virtual alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::~PresentationInterface |
( |
| ) |
|
|
virtualdefault |
◆ dismiss()
virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::dismiss |
( |
| ) |
|
|
pure virtual |
Dismiss the current presentation
◆ foreground()
virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::foreground |
( |
| ) |
|
|
pure virtual |
Request foregrounding of the current presentation
◆ getState()
virtual PresentationState alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::getState |
( |
| ) |
|
|
pure virtual |
Gets the current state for this presentation
- Returns
- The current presentation state
◆ getTimeoutDefault()
static const std::chrono::milliseconds alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::getTimeoutDefault |
( |
| ) |
|
|
inlinestatic |
Gets a value which can be used in setTimeout
that indicates the timeout should be set to the default value associated with the PresentationLifespan
for the presentation.
- Returns
- Value indicating default timeout should be used
◆ getTimeoutDisabled()
static const std::chrono::milliseconds alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::getTimeoutDisabled |
( |
| ) |
|
|
inlinestatic |
Gets a value which can be used in setTimeout
that indicates the timeout should be disabled.
- Returns
- Value indicating timeout is disabled
◆ setLifespan()
virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::setLifespan |
( |
const PresentationLifespan & |
lifespan | ) |
|
|
pure virtual |
Sets the lifespan of the presentation
- Parameters
-
lifespan | new lifespan value |
◆ setMetadata()
virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::setMetadata |
( |
const std::string & |
metadata | ) |
|
|
pure virtual |
Sets the metadata associated with this presentation
- Parameters
-
◆ setTimeout()
virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::setTimeout |
( |
const std::chrono::milliseconds & |
timeout | ) |
|
|
pure virtual |
Sets the timeout for this presentation - the new value will take effect the next time the timeout is restarted
- Parameters
-
◆ startTimeout()
virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::startTimeout |
( |
| ) |
|
|
pure virtual |
Starts or Restarts the timeout for this presentation.
- Note
- the timer will only be started if the presentation currently is focused, i.e. is in the FOREGROUND state
◆ stopTimeout()
virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationInterface::stopTimeout |
( |
| ) |
|
|
pure virtual |
Stops the timeout for this presentation
- Note
- the timer may be resumed as a result of other user actions, or presentation state change events.
The documentation for this class was generated from the following file:
- /workplace/avs-device-sdk/shared/PresentationOrchestrator/PresentationOrchestratorInterfaces/include/acsdk/PresentationOrchestratorInterfaces/PresentationInterface.h
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License, Version 2.0