alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface::Response Struct Reference

#include <LiveViewControllerInterface.h>

Public Types
enum	Type {   Type::SUCCESS, Type::FAILED_BATTERY_TOO_LOW, Type::FAILED_MEDIA_SOURCE_NOT_FOUND, Type::FAILED_MEDIA_SOURCE_ASLEEP,   Type::FAILED_MEDIA_SOURCE_TURNED_OFF, Type::FAILED_UNAUTHORIZED, Type::FAILED_INTERNAL_ERROR }

Public Member Functions
	Response ()
	Response (Type type, std::string errorMessage)

Public Attributes
Type	type
	Response error type. More...
std::string	errorMessage

Detailed Description

Utility object used for reporting LiveViewController response event.

Member Enumeration Documentation

Type

enum alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface::Response::Type

strong

Enum for the different response types.

Enumerator
SUCCESS	Request has been handled successfully.
FAILED_BATTERY_TOO_LOW	Battery level at the endpoint is too low.
FAILED_MEDIA_SOURCE_NOT_FOUND	The media source for the camera can't be found.
FAILED_MEDIA_SOURCE_ASLEEP	The media source for the camera is asleep.
FAILED_MEDIA_SOURCE_TURNED_OFF	The media source for the camera is off.
FAILED_UNAUTHORIZED	Request is not authorized to access the live view features.
FAILED_INTERNAL_ERROR	Indicates that an error occurred that can't be described by one of the other error types.

Constructor & Destructor Documentation

Response() [1/2]

alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface::Response::Response ( )

inline

Default constructor, sets response type to SUCCESS.

Response() [2/2]

alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface::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.

Member Data Documentation

errorMessage

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface::Response::errorMessage

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

type

Type alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface::Response::type

Response error type.

---

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

• /workplace/avs-device-sdk/capabilities/LiveViewController/AlexaLiveViewControllerInterfaces/include/acsdk/AlexaLiveViewControllerInterfaces/LiveViewControllerInterface.h