alexaClientSDK::alexaRecordControllerInterfaces::RecordControllerInterface Class Reference

#include <RecordControllerInterface.h>

Inheritance diagram for alexaClientSDK::alexaRecordControllerInterfaces::RecordControllerInterface:

Classes
struct	Response

Public Member Functions
virtual	~RecordControllerInterface ()=default
virtual Response	startRecording ()=0
virtual Response	stopRecording ()=0
virtual bool	isRecording ()=0

Detailed Description

The RecordControllerInterface carries out record controller actions such as start recording and stop recording.

Note

Implementations of this interface must be thread-safe.

Constructor & Destructor Documentation

~RecordControllerInterface()

virtual alexaClientSDK::alexaRecordControllerInterfaces::RecordControllerInterface::~RecordControllerInterface ( )

virtualdefault

Virtual destructor to assure proper cleanup of derived types.

Member Function Documentation

isRecording()

virtual bool alexaClientSDK::alexaRecordControllerInterfaces::RecordControllerInterface::isRecording ( )

pure virtual

Get the current recording state information of the endpoint.

Returns

whether the endpoint is currently recording.

Implemented in alexaClientSDK::alexaRecordController::test::MockRecordControllerHandlerInterface, and alexaClientSDK::sampleApplications::common::EndpointAlexaRecordControllerHandler.

startRecording()

virtual Response alexaClientSDK::alexaRecordControllerInterfaces::RecordControllerInterface::startRecording ( )

pure virtual

Start the recording of the content that is currently playing.

Returns

Whether the Recording was successfully started, or if an error was encountered in the process. RecordControllerInterface::Response.type should be set to SUCCESS if no errors were encountered. Otherwise, RecordControllerInterface::Response.type should contain the corresponding error code along with a log message in RecordControllerInterface::Response.message.

Implemented in alexaClientSDK::alexaRecordController::test::MockRecordControllerHandlerInterface, and alexaClientSDK::sampleApplications::common::EndpointAlexaRecordControllerHandler.

stopRecording()

virtual Response alexaClientSDK::alexaRecordControllerInterfaces::RecordControllerInterface::stopRecording ( )

pure virtual

Stop the current recording.

Returns

Whether the Recording was successfully stopped, or if an error was encountered in the process. RecordControllerInterface::Response.type should be set to SUCCESS if no errors were encountered. Otherwise, RecordControllerInterface::Response.type should contain the corresponding error code along with a log message in RecordControllerInterface::Response.message.

Implemented in alexaClientSDK::alexaRecordController::test::MockRecordControllerHandlerInterface, and alexaClientSDK::sampleApplications::common::EndpointAlexaRecordControllerHandler.

---

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

• /workplace/avs-device-sdk/capabilities/AlexaRecordController/AlexaRecordControllerInterfaces/include/acsdk/AlexaRecordControllerInterfaces/RecordControllerInterface.h