Public Types
enum	Type { Type::SUCCESS, Type::FAILED_TOO_MANY_FAILED_ATTEMPTS, Type::FAILED_ENDPOINT_UNREACHABLE, Type::FAILED_NOT_SUBSCRIBED, Type::FAILED_INTERNAL_ERROR }

Public Member Functions
	Response ()

	Response (Type type, std::string errorMessage)

Public Attributes
Type	type
	Response type for RemoteVideoPlayer handler responses. More...

std::string	errorMessage

Detailed Description

Utility object used for reporting RemoteVideoPlayer handler response.

Member Enumeration Documentation

strong

Enum for the different response types understood by the RemoteVideoPlayer capability agent.

Enumerator
SUCCESS	RemoteVideoPlayer Request was handled successfully.
FAILED_TOO_MANY_FAILED_ATTEMPTS	The number of allowed failed attempts to perform a RemoteVideoPlayer action has been exceeded.
FAILED_ENDPOINT_UNREACHABLE	Indicates the endpoint is unreachable or offline.
FAILED_NOT_SUBSCRIBED	The user is not subscribed to the content for a channel or other subscription-based content.
FAILED_INTERNAL_ERROR	Indicates that an error occurred that can't be described by one of the other error types.

alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::Response::Response ( )

inline

Default Constructor, set the response type to success.

alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::Response::Response	(	Type	type,
		std::string	errorMessage
	)

inline

Constructor.

Parameters

type	The response type `Type`
errorMessage	The error message if `responseType` is other than SUCCESS.

std::string alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::Response::errorMessage

The error message for logging if the responseType is anything other than SUCCESS, for the purposes of aiding debugging.

Type alexaClientSDK::alexaRemoteVideoPlayerInterfaces::RemoteVideoPlayerInterface::Response::type

Response type for RemoteVideoPlayer handler responses.

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

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