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

#include <EndpointAlexaRemoteVideoPlayerHandler.h>

Inheritance diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaRemoteVideoPlayerHandler:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaRemoteVideoPlayerHandler:
Collaboration graph
[legend]

Public Member Functions

void onFocusAcquired ()
 
RemoteVideoPlayerInterface methods
alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::Response playVideo (std::unique_ptr< alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerRequest > request) override
 
alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::Response displaySearchResults (std::unique_ptr< alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerRequest > request) override
 
alexaRemoteVideoPlayerInterfaces::Configuration getConfiguration () override
 
- Public Member Functions inherited from alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface
virtual ~RemoteVideoPlayerInterface ()=default
 
virtual Response playVideo (std::unique_ptr< RemoteVideoPlayerRequest > request)=0
 
virtual Response displaySearchResults (std::unique_ptr< RemoteVideoPlayerRequest > request)=0
 

Static Public Member Functions

static std::shared_ptr< EndpointAlexaRemoteVideoPlayerHandlercreate (std::string endpointName, std::shared_ptr< EndpointFocusAdapter > focusAdapter)
 

Detailed Description

Sample implementation of a Remote Video Player.

Member Function Documentation

◆ create()

static std::shared_ptr<EndpointAlexaRemoteVideoPlayerHandler> alexaClientSDK::sampleApplications::common::EndpointAlexaRemoteVideoPlayerHandler::create ( std::string  endpointName,
std::shared_ptr< EndpointFocusAdapter focusAdapter 
)
static

Create an EndpointAlexaRemoteVideoPlayerHandler object.

Parameters
endpointNameThe name of the endpoint.
focusAdapterThe EndpointFocusAdapter to manage focus.
Returns
A pointer to a new EndpointAlexaRemoteVideoPlayerHandler object if it succeeds; otherwise, nullptr.

◆ displaySearchResults()

alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaRemoteVideoPlayerHandler::displaySearchResults ( std::unique_ptr< alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerRequest request)
override

◆ getConfiguration()

alexaRemoteVideoPlayerInterfaces::Configuration alexaClientSDK::sampleApplications::common::EndpointAlexaRemoteVideoPlayerHandler::getConfiguration ( )
overridevirtual

Returns the Remote Video Player configuration.

Returns
A Configuration object that contains the supported directive types, entity types and catalog information.

Implements alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface.

◆ onFocusAcquired()

void alexaClientSDK::sampleApplications::common::EndpointAlexaRemoteVideoPlayerHandler::onFocusAcquired ( )

Actions performed when focus has been acquired. No OP in this stub implementation. Should invoke the video application to either start video playback or display search results.

◆ playVideo()

alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaRemoteVideoPlayerHandler::playVideo ( std::unique_ptr< alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerRequest request)
override

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