#include <AlexaPlaybackControllerInterface.h>

Public Types
enum	Type { Type::SUCCESS, Type::PLAYBACK_OPERATION_NOT_SUPPORTED, Type::NO_CONTENT_AVAILABLE, Type::NOT_SUPPORTED_IN_CURRENT_MODE, Type::INTERNAL_ERROR }

Public Member Functions
	Response ()

	Response (Type responseType, const std::string &errorMessage)

Public Attributes
Type	responseType
	The AlexaPlaybackController response type. More...

std::string	errorMessage

Detailed Description

Struct for holding AlexaPlaybackController response for AlexaPlaybackController interface

responseType should be SUCCESS if there are no errors while executing playback controller operation. Otherwise, it should return the corresponding error response along with a log message errorMessage that would be logged in the cloud, for the purposes of aiding debugging.

Member Enumeration Documentation

◆ Type

enum alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response::Type

strong

Enum for the different error types understood by the AlexaPlaybackController capability agent.

Enumerator
SUCCESS	Device processed command successfully without any errors.
PLAYBACK_OPERATION_NOT_SUPPORTED	Indicates the playback operation is not supported on the device.
NO_CONTENT_AVAILABLE	Indicates there is no audio or video content that is available when 'play', 'previous', 'next' or other playback operation is invoked.
NOT_SUPPORTED_IN_CURRENT_MODE	Indicates that the operation cannot be operated in the current mode. For example, if the device should disable 'play' operation for a video in driving mode
INTERNAL_ERROR	An error occurred that can't be described by one of the other error types. For example, a runtime exception occurred. We recommend that you always send a more specific error type, if possible.

Constructor & Destructor Documentation

◆ Response() [1/2]

alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response::Response ( )

inline

Default Constructor. Initializes the response value to 'SUCCESS' by default.

◆ Response() [2/2]

alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response::Response	(	Type	responseType,
		const std::string &	errorMessage
	)

inline

Constructor

Parameters

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

Member Data Documentation

◆ errorMessage

std::string alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response::errorMessage

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

◆ responseType

Type alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::AlexaPlaybackControllerInterface::Response::responseType

The AlexaPlaybackController response type.

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

/workplace/avs-device-sdk/capabilities/AlexaPlaybackController/acsdkAlexaPlaybackControllerInterfaces/include/acsdkAlexaPlaybackControllerInterfaces/AlexaPlaybackControllerInterface.h

Public Types

Public Member Functions

Public Attributes