AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Types | Public Member Functions | Public Attributes | List of all members
alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::Response Struct Reference

#include <VideoRecorderInterface.h>

Public Types

enum  Type {
  Type::SUCCESS, Type::FAILED_TOO_MANY_FAILED_ATTEMPTS, Type::FAILED_ACTION_NOT_PERMITTED_FOR_CONTENT, Type::FAILED_CONFIRMATION_REQUIRED,
  Type::FAILED_CONTENT_NOT_RECORDABLE, Type::FAILED_NOT_SUBSCRIBED, Type::FAILED_RECORDING_EXISTS, Type::FAILED_STORAGE_FULL,
  Type::FAILED_VIDEO_TITLE_DISAMBIGUATION_REQUIRED, Type::FAILED_RECORDING_SCHEDULE_CONFLICT
}
 

Public Member Functions

 Response ()
 

Public Attributes

Type type
 Response type for VideoRecorder handler responses. More...
 
std::string message
 Response message. More...
 

Detailed Description

Utility object used for reporting VideoRecorder handler response.

Member Enumeration Documentation

◆ Type

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

Enumerator
SUCCESS 

VideoRecorder Request was handled successfully.

FAILED_TOO_MANY_FAILED_ATTEMPTS 

The number of allowed failed attempts to perform a VideoRecorder action has been exceeded.

FAILED_ACTION_NOT_PERMITTED_FOR_CONTENT 

Indicates the content does not allow the VideoRecorder action requested. For example, if the user tries to delete a recording that is marked as not deletable.

FAILED_CONFIRMATION_REQUIRED 

Indicates an additional confirmation must occur before the requested VideoRecorder action can be completed.

FAILED_CONTENT_NOT_RECORDABLE 

Indicates the record operation failed due to restrictions on the content.

FAILED_NOT_SUBSCRIBED 

The user is not subscribed to the content for a channel or other subscription-based content.

FAILED_RECORDING_EXISTS 

Indicates that a recording request failed because the recording already exists.

FAILED_STORAGE_FULL 

Indicates that a recording request failed because the DVR storage is full.

FAILED_VIDEO_TITLE_DISAMBIGUATION_REQUIRED 

Indicates the title specified yielded multiple results, and disambiguation is required to determine the program to record. This value should be used to indicate that the target device will provide a mechanism for disambiguation. For example, this error could indicate that there are multiple airings of a program or that the entity requested for recording has multiple programs associated with it.

FAILED_RECORDING_SCHEDULE_CONFLICT 

Indicates that a recording request failed because of a scheduling conflict with another recording.

Constructor & Destructor Documentation

◆ Response()

alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::Response::Response ( )
inline

Member Data Documentation

◆ message

std::string alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::Response::message

Response message.

◆ type

Type alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::Response::type

Response type for VideoRecorder handler responses.


The documentation for this struct 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