AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Static Public Member Functions | List of all members
alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::TemplateRuntimePresentationAdapterBridge Class Reference

#include <TemplateRuntimePresentationAdapterBridge.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::TemplateRuntimePresentationAdapterBridge:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::TemplateRuntimePresentationAdapterBridge:
Collaboration graph
[legend]

Static Public Member Functions

static std::shared_ptr< TemplateRuntimePresentationAdapterBridgecreate (const std::shared_ptr< sampleApplications::common::TemplateRuntimePresentationAdapter > &templateRuntimePresentationAdapter)
 

TemplateRuntimeHandlerInterface methods

void windowIdReport (const std::string &message) override
 The TemplateRuntimePresentationAdapter. More...
 
bool setRenderPlayerInfoWindowId (const std::string &renderPlayerInfoWindowId)
 } More...
 
std::string getRenderPlayerInfoWindowId ()
 

Additional Inherited Members

- Public Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::TemplateRuntimeHandlerInterface
virtual ~TemplateRuntimeHandlerInterface ()=default
 

Detailed Description

Bridge for binding TemplateRuntime IPC messages to the TemplateRuntimePresentationAdapter

Member Function Documentation

◆ create()

static std::shared_ptr<TemplateRuntimePresentationAdapterBridge> alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::TemplateRuntimePresentationAdapterBridge::create ( const std::shared_ptr< sampleApplications::common::TemplateRuntimePresentationAdapter > &  templateRuntimePresentationAdapter)
static

Create an instance of TemplateRuntimePresentationAdapterBridge

Parameters
templateRuntimePresentationAdapterPointer to the TemplateRuntimePresentationAdapter.
Returns
Shared pointer to TemplateRuntimePresentationAdapterBridge

◆ getRenderPlayerInfoWindowId()

std::string alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::TemplateRuntimePresentationAdapterBridge::getRenderPlayerInfoWindowId ( )

Returns the render player info window id used by the adapter bridge for presentations.

Returns
the render player info window id.

◆ setRenderPlayerInfoWindowId()

bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::TemplateRuntimePresentationAdapterBridge::setRenderPlayerInfoWindowId ( const std::string &  renderPlayerInfoWindowId)

}

Sets the render player info window id on the adapter if not explicitly reported by the client via the associated TemplateRuntime windowIdReport.

Parameters
renderPlayerInfoWindowIdthe window id to use for player info window if not set by client.
Returns
returns true if the bridge accepts the explicitly set player info window id.

◆ windowIdReport()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::TemplateRuntimePresentationAdapterBridge::windowIdReport ( const std::string &  message)
overridevirtual

The documentation for this class was generated from the following file:

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