alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface Class Reference

#include <RemoteVideoPlayerInterface.h>

Inheritance diagram for alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface:

Classes
struct	Response

Public Member Functions
virtual	~RemoteVideoPlayerInterface ()=default
virtual Response	playVideo (std::unique_ptr< RemoteVideoPlayerRequest > request)=0
virtual Response	displaySearchResults (std::unique_ptr< RemoteVideoPlayerRequest > request)=0
virtual Configuration	getConfiguration ()=0

Detailed Description

The RemoteVideoPlayerInterface carries out remote video player actions such playing video content requested by the user, or displaying results for a user query.

Note

Implementations of this interface must be thread-safe.

Constructor & Destructor Documentation

~RemoteVideoPlayerInterface()

virtual alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::~RemoteVideoPlayerInterface ( )

virtualdefault

Virtual destructor to assure proper cleanup of derived types.

Member Function Documentation

displaySearchResults()

virtual Response alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::displaySearchResults ( std::unique_ptr< RemoteVideoPlayerRequest >  request )

pure virtual

Display results in response to a user query.

Parameters

request

The request for the search and display results directive.

Returns

whether the results for a user search request were successfully displayed, or if an error was encountered in the process. RemoteVideoPlayerInterface::Response.type should return SUCCESS if no errors were encountered. Otherwise, RemoteVideoPlayerInterface::Response.type should contain the corresponding error code along with a log message in RemoteVideoPlayerInterface::Response.errorMessage.

getConfiguration()

virtual Configuration alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::getConfiguration ( )

pure virtual

Returns the Remote Video Player configuration.

Returns

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

Implemented in alexaClientSDK::sampleApplications::common::EndpointAlexaRemoteVideoPlayerHandler.

playVideo()

virtual Response alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::playVideo ( std::unique_ptr< RemoteVideoPlayerRequest >  request )

pure virtual

Play video content based on a user request.

Parameters

request

The request for the search and play directive.

Returns

whether the video playback was successful, or if an error was encountered in the process. RemoteVideoPlayerInterface::Response.type should return SUCCESS if no errors were encountered. Otherwise, RemoteVideoPlayerInterface::Response.type should contain the corresponding error code along with a log message in RemoteVideoPlayerInterface::Response.errorMessage.

---

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

• /workplace/avs-device-sdk/capabilities/AlexaRemoteVideoPlayer/AlexaRemoteVideoPlayerInterfaces/include/acsdk/AlexaRemoteVideoPlayerInterfaces/RemoteVideoPlayerInterface.h